diff --git a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md index b467bfe8173b..8fc5cf632e9e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md @@ -1,5 +1,11 @@ # ARM (Control Plane) API Specification Update Pull Request +## PR review workflow diagram + +Please understand this diagram before proceeding. It explains how to get your PR approved & merged. + +![diagram](https://github.com/Azure/azure-rest-api-specs/assets/4429827/5e91ff2d-1f5c-4e96-87c2-390e7451da37) + ## Purpose of this PR What's the purpose of this PR? Check all that apply. This is **mandatory**! diff --git a/.github/PULL_REQUEST_TEMPLATE/spec_pr_review_workflow_diagram.png b/.github/PULL_REQUEST_TEMPLATE/spec_pr_review_workflow_diagram.png new file mode 100644 index 000000000000..4b5b0bfb20cb Binary files /dev/null and b/.github/PULL_REQUEST_TEMPLATE/spec_pr_review_workflow_diagram.png differ diff --git a/.github/comment.yml b/.github/comment.yml index ae1085c5231b..69a048770786 100644 --- a/.github/comment.yml +++ b/.github/comment.yml @@ -20,7 +20,9 @@ **ACTION ITEM ALTERNATIVE C**: Report false positive.
If you think there are no breaking changes, i.e. the validation should pass yet it fails, - then please explain why in a PR comment and @ the PR assignee. + then proceed as explained in **ACTION ITEM ALTERNATIVE B**.
+ This applies even if the breaking change tool fails with internal runtime error. + In such case a manual breaking change review is necessary. - rule: type: label @@ -47,7 +49,9 @@ **ACTION ITEM ALTERNATIVE C**: Report false positive.
If you think there are no changes in existing API version, i.e. there should be no `NewApiVersionRequired` label, - then please explain why in a PR comment and @ the PR assignee. + then proceed as explained in **ACTION ITEM ALTERNATIVE B**.
+ This applies even if the breaking change tool fails with internal runtime error. + In such case a manual breaking change review is necessary.

For additional guidance, please see https://aka.ms/NewApiVersionRequired diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index b01d4ea1f053..495d46dca2ea 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -10,6 +10,7 @@ # OpenAI data-plane PR paths: - "specification/cognitiveservices/data-plane/AzureOpenAI/**" + - "specification/cognitiveservices/OpenAI.Inference/**" reviewers: - lmazuel diff --git a/CODEOWNERS b/CODEOWNERS index f4d3a701ccfc..e52dafdcd5fd 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -263,5 +263,13 @@ /specification/**/resource-manager/**/readme.typescript.md @qiaozha /specification/**/resource-manager/**/readme.az.md @jsntcy @qiaozha /specification/**/resource-manager/**/readme.cli.md @jsntcy @qiaozha -/specification/**/resource-manager/**/readme.go.md @ArcturusZhang -/specification/**/resource-manager/**/readme.python.md @msyyc @Wzb123456789 +/specification/**/resource-manager/**/readme.go.md @tadelesh +/specification/**/resource-manager/**/readme.python.md @msyyc + +########### +# Eng Sys +########### +/.azure-pipelines/ @weshaggard @mikeharder @konrad-jamrozik +/.github/ @weshaggard @mikeharder @konrad-jamrozik +/eng/ @weshaggard @mikeharder @konrad-jamrozik +/scripts/ @weshaggard @mikeharder @konrad-jamrozik diff --git a/custom-words.txt b/custom-words.txt index 81bc780730fa..71df8332f534 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -532,6 +532,7 @@ continuationtoken continuousdataexports continuouswebjobs contoso +Contoso's contosodataset contosomedia contributer @@ -2175,6 +2176,7 @@ removeaclentries removedefaultacl removenodes removex +reoffer reparent replicationdetails replicationstatus @@ -2775,6 +2777,7 @@ unarchive unassign unassignment unassigns +unassigning unattend unbilled unclaim diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 43ff29d46c02..c65ccb876f7e 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -73,17 +73,20 @@ Or you can run it in [OpenAPI Hub](https://portal.azure-devex-tools.com/tools/st 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 + - 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. -- 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. + - 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. + +### Adding label on PR automatically -### 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 guildance on how to fix. + +### Run locally -### run locally run oad locally (the breaking change is reported by oad tool): ``` npm install -g @azure/oad @@ -129,6 +132,15 @@ To fix this CI check failure, if you haven't got ARM signed off, pls get ARM sig NOTE: If your RP is RPaaS RP, since RPaaS requires swagger merge first. In this case, you could ignore this CI check. +## API Doc Preview + +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): + +| Rule | Message | +|-|-| +| ❌ 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 " | + +Then refer to [this TSG](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/79/Generation-of-docs-on-learn.microsoft.com?anchor=%22swagger-apidocpreview%22-build-is-failing). ## Service API Readiness Test @@ -147,6 +159,7 @@ To fix the check, download the artifact `api_scenario_test_output` from Azure pi This validator is to ensure the TypeSpec & swagger files in PR are consistent and passing validation. ### How to fix + | Error Code |Severity |Solution | |---|---|---| |MissingTypeSpecFile| Error |Adding the related TypeSpec project into {RP-Name} folder, like [Qumulo.Manaement](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/liftrqumulo/Qumulo.Management)| @@ -163,6 +176,7 @@ See [typespec-autorest](https://azure.github.io/typespec-azure/docs/emitters/typ This validator generates traffic for all operations defined in Swagger files under default tag of readme.md by using [RESTler](https://github.com/microsoft/restler-fuzzer). Then, it validates the request and response pairs from the traffic against the corresponding Swagger definitions. Finally, it provides an html report that reports the Swagger accuracy. ### How to understand and improve the report + Please refer to [swagger-accuracy-report](./swagger-accuracy-report.md). ## Suppression Process diff --git a/eng/pipelines/templates/steps/typespec-ci.yml b/eng/pipelines/templates/steps/typespec-ci.yml deleted file mode 100644 index 992c13fd4030..000000000000 --- a/eng/pipelines/templates/steps/typespec-ci.yml +++ /dev/null @@ -1,22 +0,0 @@ -parameters: -- name: Folder - type: string -- name: DisplayName - type: string - -steps: -- bash: | - exit_code=0 - - # Log commands before running - set -x - - npx --no tsv ${{parameters.Folder}} || exit_code=1 - - # Discard any changes - git restore . - git clean -df - - exit $exit_code - displayName: ${{parameters.DisplayName}} - condition: succeededOrFailed() diff --git a/eng/pipelines/typespec-ci.yml b/eng/pipelines/typespec-ci.yml index 27aebf70c9b4..08d97f68faae 100644 --- a/eng/pipelines/typespec-ci.yml +++ b/eng/pipelines/typespec-ci.yml @@ -11,23 +11,15 @@ pr: - typespec-next paths: include: - - package.json + - .gitattributes + - .prettierrc.json - package-lock.json - - eng/pipelines/typespec-ci.yml - - eng/pipelines/templates/steps/typespec-ci.yml - - eng/tools/TypeSpecValidation - - specification/contosowidgetmanager - - specification/cognitiveservices - - specification/confidentialledger - - specification/containerservice - - specification/containerstorage - - specification/eventgrid - - specification/servicenetworking - - specification/sphere - - specification/translation + - package.json + - tsconfig.json + - eng jobs: -- job: TypeSpecCI +- job: Validate_All_Specs pool: name: azsdk-pool-mms-ubuntu-2204-general vmImage: ubuntu-22.04 @@ -40,76 +32,7 @@ jobs: displayName: npm ls -a condition: succeededOrFailed() - - script: npm run build - displayName: npm run build + - pwsh: | + $(Build.SourcesDirectory)/eng/scripts/Validate-TypeSpec.ps1 $(Build.SourcesDirectory) + displayName: Validate All Specs condition: succeededOrFailed() - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/contosowidgetmanager/Contoso.WidgetManager - DisplayName: Contoso.WidgetManager - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/AnomalyDetector - DisplayName: AnomalyDetector - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/ContentSafety - DisplayName: ContentSafety - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/HealthInsights/healthinsights.openapi - DisplayName: healthinsights.openapi - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype - DisplayName: healthinsights.oncophenotype - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher - DisplayName: healthinsights.trialmatcher - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/OpenAI.Inference - DisplayName: OpenAI.Inference - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/confidentialledger/Microsoft.ManagedCcf - DisplayName: ManagedCcf - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/containerservice/Fleet.Management - DisplayName: Fleet.Management - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/containerstorage/ContainerStorage.Management - DisplayName: ContainerStorage.Management - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/eventgrid/Azure.Messaging.EventGrid - DisplayName: Messaging.EventGrid - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/servicenetworking/ServiceNetworking.Management - DisplayName: Microsoft.ServiceNetworking - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/sphere/Sphere.Management - DisplayName: Sphere.Management - - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/translation/Azure.AI.TextTranslation - DisplayName: AI.TextTranslation diff --git a/eng/pipelines/typespec-pr.yml b/eng/pipelines/typespec-pr.yml new file mode 100644 index 000000000000..799eeec36137 --- /dev/null +++ b/eng/pipelines/typespec-pr.yml @@ -0,0 +1,32 @@ +trigger: none + +pr: + branches: + include: + - main + - typespec-next + paths: + include: + - specification + +jobs: +- job: Validate_Changed_Specs + pool: + name: azsdk-pool-mms-ubuntu-2204-general + vmImage: ubuntu-22.04 + + steps: + - script: npm ci + displayName: npm ci + + - script: npm ls -a + displayName: npm ls -a + condition: succeededOrFailed() + + - pwsh: | + $(Build.SourcesDirectory)/eng/scripts/Validate-TypeSpec.ps1 ` + $(Build.SourcesDirectory) ` + "origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH}" ` + "${env:SYSTEM_PULLREQUEST_SOURCECOMMITID}" + displayName: Validate Changed Specs + condition: succeededOrFailed() diff --git a/eng/scripts/Get-TypeSpec-Folders.ps1 b/eng/scripts/Get-TypeSpec-Folders.ps1 new file mode 100644 index 000000000000..4271184ca72b --- /dev/null +++ b/eng/scripts/Get-TypeSpec-Folders.ps1 @@ -0,0 +1,27 @@ +[CmdletBinding()] +param ( + [Parameter(Position = 0, Mandatory = $true)] + [string] $SpecsRepoRootDirectory, + [Parameter(Position = 1, Mandatory = $false)] + [string]$TargetBranch, + [Parameter(Position = 2, Mandatory = $false)] + [string]$SourceBranch +) + +$tspFiles = @() +if ([string]::IsNullOrEmpty($TargetBranch) -or [string]::IsNullOrEmpty($SourceBranch)) { + $tspFiles = (Get-ChildItem -path ./specification tspconfig.yaml -Recurse).FullName -replace "$($pwd.Path)/" +} +else { + Write-Host "git -c core.quotepath=off -c i18n.logoutputencoding=utf-8 diff --name-only `"$TargetBranch...$SourceBranch`" -- | Where-Object {`$_.StartsWith('specification')}" + $tspFiles = git -c core.quotepath=off -c i18n.logoutputencoding=utf-8 diff --name-only `"$TargetBranch...$SourceBranch`" -- | Where-Object {$_.StartsWith('specification')} +} + +$typespecFolders = @() +foreach ($file in $tspFiles) { + $file -match 'specification\/[^\/]*\/' | out-null + $typespecFolders += (Get-ChildItem -path $matches[0] tspconfig.yaml -Recurse).Directory.FullName -replace "$($pwd.Path)/" +} +$typespecFolders = $typespecFolders | Select-Object -Unique + +return $typespecFolders diff --git a/eng/scripts/Validate-TypeSpec.ps1 b/eng/scripts/Validate-TypeSpec.ps1 new file mode 100644 index 000000000000..7bd3171d001f --- /dev/null +++ b/eng/scripts/Validate-TypeSpec.ps1 @@ -0,0 +1,25 @@ +[CmdletBinding()] +param ( + [Parameter(Position = 0, Mandatory = $true)] + [string] $SpecsRepoRootDirectory, + [Parameter(Position = 1, Mandatory = $false)] + [string]$TargetBranch, + [Parameter(Position = 2, Mandatory = $false)] + [string]$SourceBranch +) + +$typespecFolders = @() + +$typespecFolders = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" "$SpecsRepoRootDirectory" "$TargetBranch" "$SourceBranch" + +$exitCode = 0 +foreach ($typespecFolder in $typespecFolders) { + npx --no tsv $typespecFolder 2>&1 | Write-Host + if ($LASTEXITCODE) { + $exitCode = 1 + } + git restore . + git clean -df +} + +exit $exitCode diff --git a/eng/tools/TypeSpecValidation/package.json b/eng/tools/TypeSpecValidation/package.json index 970c2e834420..db9f95fbd43c 100644 --- a/eng/tools/TypeSpecValidation/package.json +++ b/eng/tools/TypeSpecValidation/package.json @@ -13,6 +13,10 @@ }, "devDependencies": { "@types/debug": "^4.1.8", - "@types/node": "^18.16.18" + "@types/node": "^18.16.18", + "typescript": "~5.0.4" + }, + "scripts": { + "postinstall": "tsc" } } diff --git a/eng/tools/TypeSpecValidation/tsconfig.json b/eng/tools/TypeSpecValidation/tsconfig.json index e22799e0549a..6966315fab5d 100644 --- a/eng/tools/TypeSpecValidation/tsconfig.json +++ b/eng/tools/TypeSpecValidation/tsconfig.json @@ -3,6 +3,9 @@ "compilerOptions": { "target": "ES6", "module": "Node16", - "outDir": "./dist" + "outDir": "./dist", + + // override "importHelpers:true" in root tsconfig.json + "importHelpers": false } } diff --git a/eng/tools/package.json b/eng/tools/package.json new file mode 100644 index 000000000000..28c6f7e96e7d --- /dev/null +++ b/eng/tools/package.json @@ -0,0 +1,7 @@ +{ + "name": "azure-rest-api-specs-eng-tools", + "devDependencies": { + "@azure-tools/typespec-validation": "file:TypeSpecValidation" + }, + "private": true +} diff --git a/package-lock.json b/package-lock.json index 02ca27ba7c69..ffb7ecef3ae6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,27 +12,41 @@ "@azure-tools/cadl-azure-resource-manager": "0.26.0", "@azure-tools/cadl-providerhub": "0.26.0", "@azure-tools/typespec-apiview": "0.4.4", - "@azure-tools/typespec-autorest": "0.31.0", - "@azure-tools/typespec-azure-core": "0.31.0", - "@azure-tools/typespec-azure-resource-manager": "0.31.0", - "@azure-tools/typespec-client-generator-core": "0.31.0", - "@azure-tools/typespec-providerhub": "0.31.0", - "@azure-tools/typespec-validation": "file:eng/tools/TypeSpecValidation", + "@azure-tools/typespec-autorest": "0.32.0", + "@azure-tools/typespec-azure-core": "0.32.0", + "@azure-tools/typespec-azure-resource-manager": "0.32.0", + "@azure-tools/typespec-client-generator-core": "0.32.0", + "@azure-tools/typespec-providerhub": "0.32.0", "@azure/avocado": "^0.8.4", "@types/prettier": "^2.7.2", - "@typespec/compiler": "0.45.2", - "@typespec/http": "0.45.0", - "@typespec/openapi": "0.45.0", - "@typespec/rest": "0.45.0", - "@typespec/versioning": "0.45.0", + "@typespec/compiler": "0.46.0", + "@typespec/http": "0.46.0", + "@typespec/openapi": "0.46.0", + "@typespec/rest": "0.46.0", + "@typespec/versioning": "0.46.0", + "azure-rest-api-specs-eng-tools": "file:eng/tools", "prettier": "^2.8.8", "typescript": "~5.0.4" } }, + "eng/tools": { + "name": "azure-rest-api-specs-eng-tools", + "dev": true, + "devDependencies": { + "@azure-tools/typespec-validation": "file:TypeSpecValidation" + } + }, + "eng/tools/node_modules/@types/node": { + "version": "18.16.19", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.19.tgz", + "integrity": "sha512-IXl7o+R9iti9eBW4Wg2hx1xQDig183jj7YLn8F7udNceyfkbn1ZxmzZXuak20gR40D7pIkIY1kYGx5VIGbaHKA==", + "dev": true + }, "eng/tools/TypeSpecValidation": { "name": "@azure-tools/typespec-validation", "version": "0.0.1", "dev": true, + "hasInstallScript": true, "dependencies": { "debug": "^4.3.4", "simple-git": "^3.16.0" @@ -42,15 +56,10 @@ }, "devDependencies": { "@types/debug": "^4.1.8", - "@types/node": "^18.16.18" + "@types/node": "^18.16.18", + "typescript": "~5.0.4" } }, - "eng/tools/TypeSpecValidation/node_modules/@types/node": { - "version": "18.16.18", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.18.tgz", - "integrity": "sha512-/aNaQZD0+iSBAGnvvN2Cx92HqE5sZCPZtx2TsK+4nvV23fFe09jVDvpArXr2j9DnYlzuU9WuoykDDc6wqvpNcw==", - "dev": true - }, "node_modules/@azure-tools/cadl-apiview": { "version": "0.3.5", "resolved": "https://registry.npmjs.org/@azure-tools/cadl-apiview/-/cadl-apiview-0.3.5.tgz", @@ -166,95 +175,95 @@ } }, "node_modules/@azure-tools/typespec-autorest": { - "version": "0.31.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.31.0.tgz", - "integrity": "sha512-l/C4HyGr0ByC7FnlsoorXDIp46pbDxVPbq59XNX9sKJJ8p2297BJv7FdPlLi0BXGjEmzy93Ag4hoH9H/u54AhQ==", + "version": "0.32.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.32.0.tgz", + "integrity": "sha512-EjF1tZdoMwUgcMRA6u3ZqabnmpvXsfnkEVvC8v7iL8v80EeGpn6ZjHzeH7jp8p/is4i54DAA9b8OFmxMEOed7A==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.31.0", - "@typespec/compiler": "~0.45.0", - "@typespec/http": "~0.45.0", - "@typespec/openapi": "~0.45.0", - "@typespec/rest": "~0.45.0", - "@typespec/versioning": "~0.45.0" + "@azure-tools/typespec-azure-core": "~0.32.0", + "@typespec/compiler": "~0.46.0", + "@typespec/http": "~0.46.0", + "@typespec/openapi": "~0.46.0", + "@typespec/rest": "~0.46.0", + "@typespec/versioning": "~0.46.0" } }, "node_modules/@azure-tools/typespec-azure-core": { - "version": "0.31.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.31.0.tgz", - "integrity": "sha512-sfJyRKGzQeBAm0Tw/CWFnWnHnxZDVbkXXLHeLb76VbRwkAu1P65eENRXXQTkUX5+PxnQH7qU/3MD5WT42AFsyA==", + "version": "0.32.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.32.0.tgz", + "integrity": "sha512-KnatCnncPVXQqUMHv5TYHrrcELtCCAbBIp3oMemqU8BLECs8KefOlLvxTqnkd9nSWdbcQTuJPnafmaH8A7gtrg==", "dev": true, "dependencies": { - "@typespec/lint": "~0.45.0" + "@typespec/lint": "~0.46.0" }, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0", - "@typespec/http": "~0.45.0", - "@typespec/rest": "~0.45.0" + "@typespec/compiler": "~0.46.0", + "@typespec/http": "~0.46.0", + "@typespec/rest": "~0.46.0" } }, "node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.31.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.31.0.tgz", - "integrity": "sha512-3z+mFZZxzuw5Y1Ma+AmlYtr+UvBCCOYesD9K7NPHiAfWpPQsgMJM3TbGpjUk5GD6ID1RzBjQfDJ52ittpMNrmQ==", + "version": "0.32.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.32.0.tgz", + "integrity": "sha512-yeDhg5qC73bqlWxyNDqD0bhvsdNPKyczx3FY6hYT4xGP1fynZbk3OXEduJuDIi65f4H1e762TBZDvGPv1/y7uw==", "dev": true, "dependencies": { - "@typespec/lint": "~0.45.0" + "@typespec/lint": "~0.46.0" }, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@azure-tools/typespec-autorest": "~0.31.0", - "@azure-tools/typespec-azure-core": "~0.31.0", - "@typespec/compiler": "~0.45.0", - "@typespec/http": "~0.45.0", - "@typespec/openapi": "~0.45.0", - "@typespec/rest": "~0.45.0", - "@typespec/versioning": "~0.45.0" + "@azure-tools/typespec-autorest": "~0.32.0", + "@azure-tools/typespec-azure-core": "~0.32.0", + "@typespec/compiler": "~0.46.0", + "@typespec/http": "~0.46.0", + "@typespec/openapi": "~0.46.0", + "@typespec/rest": "~0.46.0", + "@typespec/versioning": "~0.46.0" } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.31.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.31.0.tgz", - "integrity": "sha512-+4HQ1WOgxGjwdUHahuQCvBccKVwLDFXpiYd1Gem0xCjC96YXdAMMoHK4LKXZV5v+ktd/9vgqU84R4/APJNWBAw==", + "version": "0.32.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.32.0.tgz", + "integrity": "sha512-jukmmipTgyhnVe+Bzo8b8qQNZOTyZGxHZLsBryMEJJSJQwGPIz4eZ5O/GNSRmmBSau9+Fg/TE9rB/4lelE/c0w==", "dev": true, "dependencies": { - "@typespec/lint": "~0.45.0" + "@typespec/lint": "~0.46.0" }, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0", - "@typespec/http": "~0.45.0", - "@typespec/rest": "~0.45.0", - "@typespec/versioning": "~0.45.0" + "@typespec/compiler": "~0.46.0", + "@typespec/http": "~0.46.0", + "@typespec/rest": "~0.46.0", + "@typespec/versioning": "~0.46.0" } }, "node_modules/@azure-tools/typespec-providerhub": { - "version": "0.31.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-providerhub/-/typespec-providerhub-0.31.0.tgz", - "integrity": "sha512-96tx3wKl9hHk1mS8HgFY1Bs9yO95dMJilGrdORi/UNdv5GZLlYu7OOqH5HAcGVmxjcvBvKOCvCqmrhCz46boYQ==", + "version": "0.32.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-providerhub/-/typespec-providerhub-0.32.0.tgz", + "integrity": "sha512-x6wrTxe8GdaY5RCiPLgLcKXNeIwbH7CNg+6M3DQ9DHWVEigr0tdSHUkyozLeqmaMbxUYUScinRzxoy/LR9Cklw==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@azure-tools/typespec-autorest": "~0.31.0", - "@azure-tools/typespec-azure-core": "~0.31.0", - "@azure-tools/typespec-azure-resource-manager": "~0.31.0", - "@typespec/compiler": "~0.45.0", - "@typespec/http": "~0.45.0", - "@typespec/openapi": "~0.45.0", - "@typespec/rest": "~0.45.0", - "@typespec/versioning": "~0.45.0" + "@azure-tools/typespec-autorest": "~0.32.0", + "@azure-tools/typespec-azure-core": "~0.32.0", + "@azure-tools/typespec-azure-resource-manager": "~0.32.0", + "@typespec/compiler": "~0.46.0", + "@typespec/http": "~0.46.0", + "@typespec/openapi": "~0.46.0", + "@typespec/rest": "~0.46.0", + "@typespec/versioning": "~0.46.0" } }, "node_modules/@azure-tools/typespec-validation": { @@ -848,9 +857,9 @@ "dev": true }, "node_modules/@ts-common/virtual-fs/node_modules/node-fetch": { - "version": "2.6.11", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.11.tgz", - "integrity": "sha512-4I6pdBY1EthSqDmJkiNk3JIT8cswwR9nfeW/cPdUagJYEQG7R95WRH74wpz7ma8Gh/9dI9FP+OU+0E4FvtA55w==", + "version": "2.6.12", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.12.tgz", + "integrity": "sha512-C/fGU2E8ToujUivIO0H+tpQ6HWo4eEmchoPIoXtxCrVghxdKq+QOHqEZW7tuP3KlV3bC8FRMO5nMCC7Zm1VP6g==", "dev": true, "dependencies": { "whatwg-url": "^5.0.0" @@ -926,22 +935,22 @@ "dev": true }, "node_modules/@typespec/compiler": { - "version": "0.45.2", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.45.2.tgz", - "integrity": "sha512-Te2mj24Sh0MinXPzPLINXRrjMuvuu2AsrBWrDWYjTgodt6MMRj5HiovxByFcYIjWUL3U4sHdKPXcOnAunDsd+Q==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.46.0.tgz", + "integrity": "sha512-CTt6WzGCUwXJ1w8Tto6/C3MtSa220Fo9pE2c4s+X620TxHV1kUb6ifOIkLonBbUHM++qSjXjG19kASoHXAQ08g==", "dev": true, "dependencies": { - "@babel/code-frame": "~7.21.4", + "@babel/code-frame": "~7.22.5", "ajv": "~8.12.0", "change-case": "~4.1.2", "globby": "~13.1.1", "js-yaml": "~4.1.0", - "mkdirp": "~2.1.6", "mustache": "~4.2.0", "node-watch": "~0.7.1", "picocolors": "~1.0.0", "prettier": "~2.8.7", "prompts": "~2.4.1", + "semver": "^7.3.8", "vscode-languageserver": "~8.1.0", "vscode-languageserver-textdocument": "~1.0.1", "yargs": "~17.7.1" @@ -955,12 +964,12 @@ } }, "node_modules/@typespec/compiler/node_modules/@babel/code-frame": { - "version": "7.21.4", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.21.4.tgz", - "integrity": "sha512-LYvhNKfwWSPpocw8GI7gpK2nq3HSDuEPC/uSYaALSJu9xjsalaaYFOq0Pwt5KmVqwEbZlDu81aLXwBOmD/Fv9g==", + "version": "7.22.5", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.22.5.tgz", + "integrity": "sha512-Xmwn266vad+6DAqEB2A6V/CcZVp62BbwVmcOJc2RPuwih1kw02TjQvWVWlcKGbBPd+8/0V5DEkOcizRGYsspYQ==", "dev": true, "dependencies": { - "@babel/highlight": "^7.18.6" + "@babel/highlight": "^7.22.5" }, "engines": { "node": ">=6.9.0" @@ -1047,21 +1056,6 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/@typespec/compiler/node_modules/mkdirp": { - "version": "2.1.6", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-2.1.6.tgz", - "integrity": "sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A==", - "dev": true, - "bin": { - "mkdirp": "dist/cjs/src/bin.js" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/@typespec/compiler/node_modules/vscode-jsonrpc": { "version": "8.1.0", "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.1.0.tgz", @@ -1153,65 +1147,65 @@ } }, "node_modules/@typespec/http": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.45.0.tgz", - "integrity": "sha512-D9B+CzDqoIvlerQL5R7k367R5pwvX5Ic/6YE3bkMzfq9G40TRz5ExpOf+ASmgRbKrWjm/0ppdE4IlRMCI6qFmA==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.46.0.tgz", + "integrity": "sha512-MGZxRvgqsbTlHUFd7ueWwoIXMf0ZPjWtg7K4GjfS0XR4EAmag3zz4Y85QK6vSNFj7q7SxvLMKCezlCoo8KB1SA==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0" + "@typespec/compiler": "~0.46.0" } }, "node_modules/@typespec/lint": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@typespec/lint/-/lint-0.45.0.tgz", - "integrity": "sha512-dACuEDQD1CFLftiKIcbWrARMb7lKEXMKE+GzsSa39Xogxv4FH6wc932tPwcMXXTdpfDO2dWUoquEcvXHxUAYKQ==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@typespec/lint/-/lint-0.46.0.tgz", + "integrity": "sha512-aIW4rnBFhjMbfdLdPw0u5sx2Gn4uOWhqp4ttLv27hy8/itsDBEPzDd9ID+gy6AlsRqfJRwnK3xRiknLr+No6wA==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0" + "@typespec/compiler": "~0.46.0" } }, "node_modules/@typespec/openapi": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.45.0.tgz", - "integrity": "sha512-6W6DMCiXb2iLH4TLgI/u8FFS5v/oBu0DZF2BER6Pzx6v5mURmYGjXiwrQ+DrkOXtqb0YLZMuDU1s9CXQe6P87Q==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.46.0.tgz", + "integrity": "sha512-br54z+FpLU7T08Q89KBnhrGM7U+LfI0KnTbqpb0c8M0NZ+nbJvKGAVAHO/NcCA6J8L3TTEkUC1GaWhiwrUF8RQ==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0", - "@typespec/http": "~0.45.0", - "@typespec/rest": "~0.45.0" + "@typespec/compiler": "~0.46.0", + "@typespec/http": "~0.46.0", + "@typespec/rest": "~0.46.0" } }, "node_modules/@typespec/rest": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.45.0.tgz", - "integrity": "sha512-u9vFmXvoKdkffh0I2LDDPAKNpILuaxu/aaMRdLEw1Zfmes2mWDruReMjPU8piRB+hE5eDDxU4INPtudy2D61tA==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.46.0.tgz", + "integrity": "sha512-WmSCI/J1QRy9W6Cq9595jqjyzCTYpOAWzzVDNMdyWH66BRVp3ckBdaXRynq1HfkUBaRd9qQCZGv1rA6qqhVTCA==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0" + "@typespec/compiler": "~0.46.0" } }, "node_modules/@typespec/versioning": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.45.0.tgz", - "integrity": "sha512-Hocyi9AAuPu9az7Aw4GiWk5CUhq9CQBx8KEDVqIEBI1AvZACPNqJU02TClSyMSKWZY6V/2Gb8lxvPyNvyiF8Hw==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.46.0.tgz", + "integrity": "sha512-f0/pxvV+CZAfFZjQYS/tVm3qY9BigijCtja1vPeHBqe92TxQW10+He82LLOv6udAdRzuy+Zd+B8kzLVXa3ShUQ==", "dev": true, "engines": { "node": ">=16.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.45.0" + "@typespec/compiler": "~0.46.0" } }, "node_modules/ajv": { @@ -1275,6 +1269,10 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", "dev": true }, + "node_modules/azure-rest-api-specs-eng-tools": { + "resolved": "eng/tools", + "link": true + }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", @@ -1556,9 +1554,9 @@ "dev": true }, "node_modules/fast-glob": { - "version": "3.2.12", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz", - "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.0.tgz", + "integrity": "sha512-ChDuvbOypPuNjO8yIDf36x7BlZX1smcUMTTcyoIjycexOxd6DFsKsg21qVBzEmr3G7fUKIRy2/psii+CIUt7FA==", "dev": true, "dependencies": { "@nodelib/fs.stat": "^2.0.2", @@ -2347,9 +2345,9 @@ } }, "node_modules/semver": { - "version": "7.5.3", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.3.tgz", - "integrity": "sha512-QBlUtyVk/5EeHbi7X0fw6liDZc7BBmEaSYn01fMU1OUYbf6GPsbTtd8WmnqbI20SeycoHSeiybkE/q1Q+qlThQ==", + "version": "7.5.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", + "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", "dev": true, "dependencies": { "lru-cache": "^6.0.0" diff --git a/package.json b/package.json index aa91a25e21fc..04c8ab07c302 100644 --- a/package.json +++ b/package.json @@ -7,24 +7,21 @@ "@azure-tools/cadl-azure-resource-manager": "0.26.0", "@azure-tools/cadl-providerhub": "0.26.0", "@azure-tools/typespec-apiview": "0.4.4", - "@azure-tools/typespec-autorest": "0.31.0", - "@azure-tools/typespec-azure-core": "0.31.0", - "@azure-tools/typespec-azure-resource-manager": "0.31.0", - "@azure-tools/typespec-client-generator-core": "0.31.0", - "@azure-tools/typespec-providerhub": "0.31.0", - "@azure-tools/typespec-validation": "file:eng/tools/TypeSpecValidation", - "@typespec/compiler": "0.45.2", - "@typespec/http": "0.45.0", - "@typespec/openapi": "0.45.0", - "@typespec/rest": "0.45.0", - "@typespec/versioning": "0.45.0", + "@azure-tools/typespec-autorest": "0.32.0", + "@azure-tools/typespec-azure-core": "0.32.0", + "@azure-tools/typespec-azure-resource-manager": "0.32.0", + "@azure-tools/typespec-client-generator-core": "0.32.0", + "@azure-tools/typespec-providerhub": "0.32.0", + "@typespec/compiler": "0.46.0", + "@typespec/http": "0.46.0", + "@typespec/openapi": "0.46.0", + "@typespec/rest": "0.46.0", + "@typespec/versioning": "0.46.0", "@azure/avocado": "^0.8.4", "@types/prettier": "^2.7.2", + "azure-rest-api-specs-eng-tools": "file:eng/tools", "prettier": "^2.8.8", "typescript": "~5.0.4" }, - "scripts": { - "build": "npx --no tsc -- -p eng/tools/TypeSpecValidation" - }, "private": true } diff --git a/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp b/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp index bc44d4a8848d..cf46311a6b6c 100644 --- a/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp +++ b/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp @@ -404,5 +404,6 @@ model ResponseError { @header("x-ms-error-code") @doc("Error code.") msErrorCode?: string; + ...ErrorResponse; } diff --git a/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp b/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp index d74eff349b26..ec75d7e48398 100644 --- a/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp +++ b/specification/cognitiveservices/AnomalyDetector/multivariate/routes.tsp @@ -14,7 +14,7 @@ namespace AnomalyDetector.Multivariate; @post @doc("Operation template for multivariate anomaly detection service action.") op MultivariateServiceAction( - ...TParams + ...TParams, ): TResponse | ResponseError; // Operations @@ -35,7 +35,7 @@ op getMultivariateBatchDetectionResult( @format("uuid") @doc("ID of a batch detection result.") @path - resultId: string + resultId: string, ): MultivariateDetectionResult | ResponseError; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Azure core RpcOperation does not support custom error response" @@ -68,6 +68,7 @@ op trainMultivariateModel is MultivariateServiceAction< @doc("Location and ID of the model.") @header location: string; + @body result: AnomalyDetectionModel; } >; @@ -84,7 +85,7 @@ op trainMultivariateModel is MultivariateServiceAction< @doc("List models of a resource.") op listMultivariateModels( ...SkipQueryParameter, - ...TopQueryParameter + ...TopQueryParameter, ): ModelList | ResponseError; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Does not fit any standard operation pattern" @@ -98,7 +99,7 @@ op listMultivariateModels( op deleteMultivariateModel( @doc("Model identifier.") @path - modelId: string + modelId: string, ): { @doc("Delete model successfully.") @statusCode @@ -119,7 +120,7 @@ and variables used in the model. op getMultivariateModel( @doc("Model identifier.") @path - modelId: string + modelId: string, ): AnomalyDetectionModel | ResponseError; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Does not fit any standard operation pattern" @@ -144,7 +145,7 @@ op detectMultivariateBatchAnomaly( @doc("Request of multivariate anomaly detection.") @body - options: MultivariateBatchDetectionOptions + options: MultivariateBatchDetectionOptions, ): { @statusCode statusCode: 202; @@ -155,6 +156,7 @@ op detectMultivariateBatchAnomaly( @doc("Location of the detection result.") @header("Operation-Location") operationLocation: string; + @body result: MultivariateDetectionResult; } | ResponseError; @@ -177,5 +179,5 @@ op detectMultivariateLastAnomaly( @doc("Request of the last detection.") @body - options: MultivariateLastDetectionOptions + options: MultivariateLastDetectionOptions, ): MultivariateLastDetectionResult | ResponseError; diff --git a/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp b/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp index a0b3c79da65f..fad570c9f1c4 100644 --- a/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp +++ b/specification/cognitiveservices/AnomalyDetector/univariate/routes.tsp @@ -12,7 +12,7 @@ namespace AnomalyDetector.Univariate; @post @doc("Operation template for univariate anomaly detection service action.") op UnivariateServiceAction( - ...TParams + ...TParams, ): TResponse | AnomalyDetectorError; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Azure core RpcOperation does not support custom error response" diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp index 6d6839e661f7..bb3d0dcde428 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp @@ -85,6 +85,7 @@ system. model TrialMatcherInferenceEvidence { @doc("A piece of evidence from the eligibility criteria text of a clinical trial.") eligibilityCriteriaEvidence?: string; + ...InferenceEvidence; } diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/model.oncophenotype.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/model.oncophenotype.tsp index adf92080ef4c..35607ffdc641 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/model.oncophenotype.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/model.oncophenotype.tsp @@ -46,6 +46,7 @@ model OncoPhenotypePatientResult { model OncoPhenotypeInference { @doc("The type of the Onco Phenotype inference") type: OncoPhenotypeInferenceType; + ...Inference; @doc("The evidence corresponding to the inference value.") diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/model.trialmatcher.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/model.trialmatcher.tsp index 00827dd71ff5..c42a7fbfa3bf 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/model.trialmatcher.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/model.trialmatcher.tsp @@ -87,6 +87,7 @@ The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, model TrialMatcherInference { @doc("The type of the Trial Matcher inference.") type: TrialMatcherInferenceType; + ...Inference; @doc("The evidence corresponding to the inference value.") @@ -328,6 +329,7 @@ model ContactDetails { model ClinicalTrialResearchFacility { @doc("The facility's name.") name: string; + ...GeographicLocation; } diff --git a/specification/cognitiveservices/OpenAI.Inference/main.tsp b/specification/cognitiveservices/OpenAI.Inference/main.tsp index 90b8cecb0bda..170ef8da71c6 100644 --- a/specification/cognitiveservices/OpenAI.Inference/main.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/main.tsp @@ -55,7 +55,8 @@ enum ServiceApiVersions { @TypeSpec.Rest.resource("deployments") model Deployment { @visibility("read") - @doc("deployment id of the deployed model") + @doc("Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.") + @projectedName("java", "deploymentOrModelName") @key deploymentId: string; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp index 4968671b3349..808bbbc8bb28 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp @@ -32,9 +32,10 @@ model ChatMessage { @projectedName("json", "role") role: ChatRole; + #suppress "@azure-tools/typespec-azure-core/no-nullable" "we explicitly want a nullable string" @doc("The text associated with this message payload.") @projectedName("json", "content") - content?: string; + content: string | null; @doc(""" The name of the author of this message. `name` is required if role is `function`, and it should be the name of the @@ -190,7 +191,7 @@ model ChatChoice { index: int32; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" - #suppress "@azure-tools/typespec-autorest/union-unsupported" "https://github.com/Azure/typespec-azure/issues/3180" + #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") finishReason: CompletionsFinishReason | null; @@ -199,6 +200,15 @@ model ChatChoice { @projectedName("json", "delta") @projectedName("csharp", "InternalStreamingDeltaMessage") delta?: ChatMessage; + + @doc(""" + 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. + """) + @added(ServiceApiVersions.v2023_06_01_Preview) + @projectedName("json", "content_filter_results") + contentFilterResults?: ContentFilterResults; } @doc(""" @@ -216,8 +226,9 @@ model ChatCompletions { represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. """) @projectedName("json", "created") - @projectedName("csharp", "InternalCreatedSecondsAfterUnixEpoch") - created: int32; + @projectedName("java", "createdAt") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; @doc(""" The collection of completions choices associated with this completions response. @@ -227,6 +238,14 @@ model ChatCompletions { @projectedName("json", "choices") choices: ChatChoice[]; + @doc(""" + 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. + """) + @added(ServiceApiVersions.v2023_06_01_Preview) + @projectedName("json", "prompt_annotations") + promptFilterResults?: PromptFilterResult[]; + @doc(""" Usage information for tokens processed and generated as part of this completions operation. """) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions.common.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions.common.tsp index c0cb9121c20e..10608fa6e4f1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions.common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions.common.tsp @@ -43,3 +43,96 @@ enum CompletionsFinishReason { @added(ServiceApiVersions.v2023_07_01_Preview) functionCall: "function_call", } + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc("Ratings for the intensity and risk level of harmful content.") +enum ContentFilterSeverity { + @doc(""" + Content may be related to violence, self-harm, sexual, or hate categories but the terms + are used in general, journalistic, scientific, medical, and similar professional contexts, + which are appropriate for most audiences. + """) + safe: "safe", + + @doc(""" + Content that expresses prejudiced, judgmental, or opinionated views, includes offensive + use of language, stereotyping, use cases exploring a fictional world (for example, gaming, + literature) and depictions at low intensity. + """) + low: "low", + + @doc(""" + Content that uses offensive, insulting, mocking, intimidating, or demeaning language + towards specific identity groups, includes depictions of seeking and executing harmful + instructions, fantasies, glorification, promotion of harm at medium intensity. + """) + medium: "medium", + + @doc(""" + Content that displays explicit and severe harmful instructions, actions, + damage, or abuse; includes endorsement, glorification, or promotion of severe + harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual + power exchange or abuse. + """) + high: "high", +} + +@added(ServiceApiVersions.v2023_06_01_Preview) +@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; +} + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc("Information about the content filtering category, if it has been detected.") +model ContentFilterResults { + @doc(""" + Describes language related to anatomical organs and genitals, romantic relationships, + acts portrayed in erotic or affectionate terms, physical sexual acts, including + those portrayed as an assault or a forced sexual violent act against one’s will, + prostitution, pornography, and abuse. + """) + sexual?: ContentFilterResult; + + @doc(""" + Describes language related to physical actions intended to hurt, injure, damage, or + kill someone or something; describes weapons, etc. + """) + violence?: ContentFilterResult; + + @doc(""" + Describes language attacks or uses that include pejorative or discriminatory language + with reference to a person or identity group on the basis of certain differentiating + attributes of these groups including but not limited to race, ethnicity, nationality, + gender identity and expression, sexual orientation, religion, immigration status, ability + status, personal appearance, and body size. + """) + hate?: ContentFilterResult; + + @doc(""" + Describes language related to physical actions intended to purposely hurt, injure, + or damage one’s body, or kill oneself. + """) + @projectedName("json", "self_harm") + selfHarm?: ContentFilterResult; +} + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc(""" +Content filtering results for a single prompt in the request. +""") +model PromptFilterResult { + @doc("The index of this prompt in the set of prompt results") + @projectedName("json", "prompt_index") + promptIndex: int32; + + @doc("Content filtering results for this prompt") + @projectedName("json", "content_filter_results") + contentFilterResults?: ContentFilterResults; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp index c3f695e16ecf..e65c4c7f1967 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp @@ -1,9 +1,11 @@ import "@typespec/rest"; import "@typespec/http"; +import "@typespec/versioning"; import "./completions.common.tsp"; using TypeSpec.Rest; using TypeSpec.Http; +using TypeSpec.Versioning; namespace Azure.OpenAI; @@ -156,8 +158,17 @@ model Completions { represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970. """) @projectedName("json", "created") - @projectedName("csharp", "InternalCreatedSecondsAfterUnixEpoch") - created: int32; + @projectedName("java", "createdAt") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; + + @doc(""" + 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. + """) + @added(ServiceApiVersions.v2023_06_01_Preview) + @projectedName("json", "prompt_annotations") + promptFilterResults?: PromptFilterResult[]; @doc(""" The collection of completions choices associated with this completions response. @@ -188,6 +199,15 @@ model Choice { @projectedName("json", "index") index: int32; + @doc(""" + 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. + """) + @added(ServiceApiVersions.v2023_06_01_Preview) + @projectedName("json", "content_filter_results") + contentFilterResults?: ContentFilterResults; + #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") @@ -195,7 +215,7 @@ model Choice { logprobs: CompletionsLogProbabilityModel | null; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" - #suppress "@azure-tools/typespec-autorest/union-unsupported" "https://github.com/Azure/typespec-azure/issues/3180" + #suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred" @doc("Reason for finishing") @projectedName("json", "finish_reason") finishReason: CompletionsFinishReason | null; @@ -214,15 +234,18 @@ model CompletionsLogProbabilityModel { @doc("A collection of log probability values for the tokens in this completions data.") @projectedName("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") @projectedName("csharp", "TopLogProbabilities") + @projectedName("java", "topLogProbabilities") topLogprobs: Record[]; @doc("The text offsets associated with tokens in this completions data.") @projectedName("json", "text_offset") @projectedName("csharp", "TextOffsets") + @projectedName("java", "textOffsets") textOffset: int32[]; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp index 506615ae7491..94806ec160c1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp @@ -60,6 +60,7 @@ model EmbeddingItem { embedding: float32[]; @doc("Index of the prompt to which the EmbeddingItem corresponds.") + @projectedName("java", "promptIndex") index: int32; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images.tsp index cc9dffd6601d..6dc36991511e 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images.tsp @@ -76,12 +76,13 @@ model ImagePayload { @added(ServiceApiVersions.v2023_06_01_Preview) model ImageGenerations { @doc("A timestamp when this job or item was created (in unix epochs).") - @projectedName("csharp", "InternalCreatedSecondsAfterUnixEpoch") - created: int64; + @projectedName("json", "created") + @projectedName("java", "createdAt") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; #suppress "@azure-tools/typespec-autorest/union-unsupported" "openapi v2 not required" @doc("The images generated by the operator.") - @projectedName("csharp", "InternalEmittedImageResponseItems") data: ImageLocation[] | ImagePayload[]; } @@ -96,7 +97,10 @@ model BatchImageGenerationOperationResponse { id: string; @doc("A timestamp when this job or item was created (in unix epochs).") - created: int64; + @projectedName("json", "created") + @projectedName("java", "createdAt") + @encode(DateTimeKnownEncoding.unixTimestamp, int32) + created: utcDateTime; @doc("A timestamp when this operation and its associated images expire and will be deleted (in unix epochs).") expires?: int64; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes.tsp b/specification/cognitiveservices/OpenAI.Inference/routes.tsp index 989654ca7e84..6e9479864283 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes.tsp @@ -54,7 +54,7 @@ op getChatCompletions is ResourceAction< // Note: pending resolution of cross-language code emission behavior for long-running operations, image generation // reuses its final operation response model as its status polling model. - +#suppress "@azure-tools/typespec-azure-core/rpc-operation-request-body" "MUST fix in next update" #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Allowed because this is a non-standard status polling operation." @doc("Returns the status of the images operation") @added(ServiceApiVersions.v2023_06_01_Preview) diff --git a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml index b3d1870826b6..29557c0d3375 100644 --- a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml +++ b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml @@ -23,6 +23,8 @@ options: partial-update: true enable-sync-stack: true generate-tests: false + custom-types-subpackage: "implementation.models" + custom-types: "FunctionCallModelBase,FunctionCallPreset,FunctionCallPresetFunctionCallModel,FunctionDefinition,FunctionNameFunctionCallModel" # "@azure-tools/typespec-ts": # package-dir: "azure-ai-openai" # emitter-output-dir: "{project-root}/generated" diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json b/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json index d7cfee0c8582..74a0e78f73c0 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json @@ -61,8 +61,8 @@ "AnomalyDetectorApiKeyAuth": { "type": "apiKey", "description": "The secret key for your Azure Cognitive Services subscription.", - "in": "header", - "name": "Ocp-Apim-Subscription-Key" + "name": "Ocp-Apim-Subscription-Key", + "in": "header" } }, "tags": [], @@ -76,8 +76,8 @@ { "name": "resultId", "in": "path", - "required": true, "description": "ID of a batch detection result.", + "required": true, "type": "string", "format": "uuid" } @@ -91,14 +91,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, @@ -110,168 +110,168 @@ } }, "/multivariate/models": { - "post": { - "operationId": "Multivariate_TrainMultivariateModel", - "summary": "Train a Multivariate Anomaly Detection Model", - "description": "Create and train a multivariate anomaly detection model. The request must\ninclude a source parameter to indicate an Azure Blob\nStorage URI that's accessible to the service. There are two types of data input. The Blob Storage URI can point to an Azure Blob\nStorage folder that contains multiple CSV files, where each CSV file has\ntwo columns, time stamp and variable. Or the Blob Storage URI can point to a single blob that contains a CSV file that has all the variables and a\ntime stamp column.\nThe model object will be created and returned in the response, but the\ntraining process happens asynchronously. To check the training status, call\nGetMultivariateModel with the modelId value and check the status field in the\nmodelInfo object.", + "get": { + "operationId": "Multivariate_ListMultivariateModels", + "summary": "List Multivariate Models", + "description": "List models of a resource.", "parameters": [ { - "name": "modelInfo", - "in": "body", - "required": true, - "description": "Model information.", - "schema": { - "$ref": "#/definitions/Multivariate.ModelInfo" - } + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" } ], "responses": { - "201": { - "description": "The request has succeeded and a new resource has been created as a result.", - "headers": { - "location": { - "description": "Location and ID of the model.", - "type": "string" - } - }, + "200": { + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/Multivariate.AnomalyDetectionModel" + "$ref": "#/definitions/Multivariate.ModelList" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, "x-ms-examples": { - "Create and train multivariate model": { - "$ref": "./examples/TrainModel.json" + "List multivariate models": { + "$ref": "./examples/ListModel.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } }, - "get": { - "operationId": "Multivariate_ListMultivariateModels", - "summary": "List Multivariate Models", - "description": "List models of a resource.", + "post": { + "operationId": "Multivariate_TrainMultivariateModel", + "summary": "Train a Multivariate Anomaly Detection Model", + "description": "Create and train a multivariate anomaly detection model. The request must\ninclude a source parameter to indicate an Azure Blob\nStorage URI that's accessible to the service. There are two types of data input. The Blob Storage URI can point to an Azure Blob\nStorage folder that contains multiple CSV files, where each CSV file has\ntwo columns, time stamp and variable. Or the Blob Storage URI can point to a single blob that contains a CSV file that has all the variables and a\ntime stamp column.\nThe model object will be created and returned in the response, but the\ntraining process happens asynchronously. To check the training status, call\nGetMultivariateModel with the modelId value and check the status field in the\nmodelInfo object.", "parameters": [ { - "$ref": "#/parameters/Azure.Core.SkipQueryParameter" - }, - { - "$ref": "#/parameters/Azure.Core.TopQueryParameter" + "name": "modelInfo", + "in": "body", + "description": "Model information.", + "required": true, + "schema": { + "$ref": "#/definitions/Multivariate.ModelInfo" + } } ], "responses": { - "200": { - "description": "The request has succeeded.", + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { - "$ref": "#/definitions/Multivariate.ModelList" + "$ref": "#/definitions/Multivariate.AnomalyDetectionModel" + }, + "headers": { + "location": { + "type": "string", + "description": "Location and ID of the model." + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "List multivariate models": { - "$ref": "./examples/ListModel.json" + "Create and train multivariate model": { + "$ref": "./examples/TrainModel.json" } } } }, "/multivariate/models/{modelId}": { - "delete": { - "operationId": "Multivariate_DeleteMultivariateModel", - "summary": "Delete Multivariate Model", - "description": "Delete an existing multivariate model according to the modelId value.", + "get": { + "operationId": "Multivariate_GetMultivariateModel", + "summary": "Get Multivariate Model", + "description": "Get detailed information about the multivariate model, including the training status\nand variables used in the model.", "parameters": [ { "name": "modelId", "in": "path", - "required": true, "description": "Model identifier.", + "required": true, "type": "string" } ], "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Multivariate.AnomalyDetectionModel" + } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, "x-ms-examples": { - "Delete multivariate model": { - "$ref": "./examples/DeleteModel.json" + "Get a multivariate model": { + "$ref": "./examples/GetModel.json" } } }, - "get": { - "operationId": "Multivariate_GetMultivariateModel", - "summary": "Get Multivariate Model", - "description": "Get detailed information about the multivariate model, including the training status\nand variables used in the model.", + "delete": { + "operationId": "Multivariate_DeleteMultivariateModel", + "summary": "Delete Multivariate Model", + "description": "Delete an existing multivariate model according to the modelId value.", "parameters": [ { "name": "modelId", "in": "path", - "required": true, "description": "Model identifier.", + "required": true, "type": "string" } ], "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/Multivariate.AnomalyDetectionModel" - } + "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/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, "x-ms-examples": { - "Get a multivariate model": { - "$ref": "./examples/GetModel.json" + "Delete multivariate model": { + "$ref": "./examples/DeleteModel.json" } } } @@ -285,15 +285,15 @@ { "name": "modelId", "in": "path", - "required": true, "description": "Model identifier.", + "required": true, "type": "string" }, { "name": "options", "in": "body", - "required": true, "description": "Request of multivariate anomaly detection.", + "required": true, "schema": { "$ref": "#/definitions/Multivariate.MultivariateBatchDetectionOptions" } @@ -302,30 +302,30 @@ "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/Multivariate.MultivariateDetectionResult" + }, "headers": { "Operation-Id": { - "description": "ID of the detection result.", - "type": "string" + "type": "string", + "description": "ID of the detection result." }, "Operation-Location": { - "description": "Location of the detection result.", - "type": "string" + "type": "string", + "description": "Location of the detection result." } - }, - "schema": { - "$ref": "#/definitions/Multivariate.MultivariateDetectionResult" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, @@ -345,15 +345,15 @@ { "name": "modelId", "in": "path", - "required": true, "description": "Model identifier.", + "required": true, "type": "string" }, { "name": "options", "in": "body", - "required": true, "description": "Request of the last detection.", + "required": true, "schema": { "$ref": "#/definitions/Multivariate.MultivariateLastDetectionOptions" } @@ -368,14 +368,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Multivariate.ResponseError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Multivariate.ResponseError" } } }, @@ -395,8 +395,8 @@ { "name": "options", "in": "body", - "required": true, "description": "Method of univariate anomaly detection.", + "required": true, "schema": { "$ref": "#/definitions/Univariate.UnivariateChangePointDetectionOptions" } @@ -411,14 +411,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Univariate.AnomalyDetectorError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Univariate.AnomalyDetectorError" } } }, @@ -438,8 +438,8 @@ { "name": "options", "in": "body", - "required": true, "description": "Method of univariate anomaly detection.", + "required": true, "schema": { "$ref": "#/definitions/Univariate.UnivariateDetectionOptions" } @@ -454,14 +454,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Univariate.AnomalyDetectorError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Univariate.AnomalyDetectorError" } } }, @@ -481,8 +481,8 @@ { "name": "options", "in": "body", - "required": true, "description": "Method of univariate anomaly detection.", + "required": true, "schema": { "$ref": "#/definitions/Univariate.UnivariateDetectionOptions" } @@ -497,14 +497,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Univariate.AnomalyDetectorError" + }, "headers": { "x-ms-error-code": { "description": "Error code.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Univariate.AnomalyDetectorError" } } }, @@ -530,6 +530,7 @@ }, "Multivariate.AlignPolicy": { "type": "object", + "description": "Manner of aligning multiple variables.", "properties": { "alignMode": { "$ref": "#/definitions/Multivariate.AlignMode", @@ -544,16 +545,16 @@ "format": "float", "description": "Field that's required when fillNAMethod is Fixed." } - }, - "description": "Manner of aligning multiple variables." + } }, "Multivariate.AnomalyDetectionModel": { "type": "object", + "description": "Response of getting a model.", "properties": { "modelId": { "type": "string", - "description": "Model identifier.", - "format": "uuid" + "format": "uuid", + "description": "Model identifier." }, "createdTime": { "type": "string", @@ -570,7 +571,6 @@ "description": "Training result of a model, including its status, errors, and diagnostics\ninformation." } }, - "description": "Response of getting a model.", "required": [ "modelId", "createdTime", @@ -579,6 +579,7 @@ }, "Multivariate.AnomalyInterpretation": { "type": "object", + "description": "Interpretation of the anomalous time stamp.", "properties": { "variable": { "type": "string", @@ -593,11 +594,11 @@ "$ref": "#/definitions/Multivariate.CorrelationChanges", "description": "Correlation changes among the anomalous variables." } - }, - "description": "Interpretation of the anomalous time stamp." + } }, "Multivariate.AnomalyState": { "type": "object", + "description": "Anomaly status and information.", "properties": { "timestamp": { "type": "string", @@ -610,21 +611,20 @@ }, "errors": { "type": "array", + "description": "Error message for the current time stamp.", "items": { "$ref": "#/definitions/Multivariate.ErrorResponse" }, - "x-ms-identifiers": [], - "description": "Error message for the current time stamp.", - "x-typespec-name": "Multivariate.ErrorResponse[]" + "x-ms-identifiers": [] } }, - "description": "Anomaly status and information.", "required": [ "timestamp" ] }, "Multivariate.AnomalyValue": { "type": "object", + "description": "Detailed information of the anomalous time stamp.", "properties": { "isAnomaly": { "type": "boolean", @@ -646,15 +646,13 @@ }, "interpretation": { "type": "array", + "description": "Interpretation of this anomalous time stamp.", "items": { "$ref": "#/definitions/Multivariate.AnomalyInterpretation" }, - "x-ms-identifiers": [], - "description": "Interpretation of this anomalous time stamp.", - "x-typespec-name": "Multivariate.AnomalyInterpretation[]" + "x-ms-identifiers": [] } }, - "description": "Detailed information of the anomalous time stamp.", "required": [ "isAnomaly", "severity", @@ -663,17 +661,16 @@ }, "Multivariate.CorrelationChanges": { "type": "object", + "description": "Correlation changes among the anomalous variables.", "properties": { "changedVariables": { "type": "array", + "description": "Correlated variables that have correlation changes under an anomaly.", "items": { "type": "string" - }, - "description": "Correlated variables that have correlation changes under an anomaly.", - "x-typespec-name": "string[]" + } } - }, - "description": "Correlation changes among the anomalous variables." + } }, "Multivariate.DataSchema": { "type": "string", @@ -701,6 +698,7 @@ }, "Multivariate.DiagnosticsInfo": { "type": "object", + "description": "Diagnostics information to help inspect the states of a model or variable.", "properties": { "modelState": { "$ref": "#/definitions/Multivariate.ModelState", @@ -708,18 +706,17 @@ }, "variableStates": { "type": "array", + "description": "Variable status.", "items": { "$ref": "#/definitions/Multivariate.VariableState" }, - "x-ms-identifiers": [], - "description": "Variable status.", - "x-typespec-name": "Multivariate.VariableState[]" + "x-ms-identifiers": [] } - }, - "description": "Diagnostics information to help inspect the states of a model or variable." + } }, "Multivariate.ErrorResponse": { "type": "object", + "description": "Error information that the API returned.", "properties": { "code": { "type": "string", @@ -730,7 +727,6 @@ "description": "Message that explains the error that the service reported." } }, - "description": "Error information that the API returned.", "required": [ "code", "message" @@ -753,6 +749,7 @@ }, "Multivariate.ModelInfo": { "type": "object", + "description": "Training result of a model, including its status, errors, and diagnostics\ninformation.", "properties": { "dataSource": { "type": "string", @@ -794,13 +791,12 @@ }, "errors": { "type": "array", + "description": "Error messages after failure to create a model.", "items": { "$ref": "#/definitions/Multivariate.ErrorResponse" }, - "x-ms-identifiers": [], - "description": "Error messages after failure to create a model.", - "x-typespec-name": "Multivariate.ErrorResponse[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "diagnosticsInfo": { "$ref": "#/definitions/Multivariate.DiagnosticsInfo", @@ -808,7 +804,6 @@ "readOnly": true } }, - "description": "Training result of a model, including its status, errors, and diagnostics\ninformation.", "required": [ "dataSource", "startTime", @@ -817,15 +812,15 @@ }, "Multivariate.ModelList": { "type": "object", + "description": "Response of listing models.", "properties": { "models": { "type": "array", + "description": "List of models.", "items": { "$ref": "#/definitions/Multivariate.AnomalyDetectionModel" }, - "x-ms-identifiers": [], - "description": "List of models.", - "x-typespec-name": "Multivariate.AnomalyDetectionModel[]" + "x-ms-identifiers": [] }, "currentCount": { "type": "integer", @@ -842,7 +837,6 @@ "description": "Link to fetch more models." } }, - "description": "Response of listing models.", "required": [ "models", "currentCount", @@ -851,45 +845,41 @@ }, "Multivariate.ModelState": { "type": "object", + "description": "Model status.", "properties": { "epochIds": { "type": "array", + "description": "Number of passes of the entire training dataset that the\nalgorithm has completed.", "items": { "type": "integer", "format": "int32" - }, - "description": "Number of passes of the entire training dataset that the\nalgorithm has completed.", - "x-typespec-name": "int32[]" + } }, "trainLosses": { "type": "array", + "description": "List of metrics used to assess how the model fits the training data for each\nepoch.", "items": { "type": "number", "format": "float" - }, - "description": "List of metrics used to assess how the model fits the training data for each\nepoch.", - "x-typespec-name": "float32[]" + } }, "validationLosses": { "type": "array", + "description": "List of metrics used to assess how the model fits the validation set for each\nepoch.", "items": { "type": "number", "format": "float" - }, - "description": "List of metrics used to assess how the model fits the validation set for each\nepoch.", - "x-typespec-name": "float32[]" + } }, "latenciesInSeconds": { "type": "array", + "description": "Latency for each epoch.", "items": { "type": "number", "format": "float" - }, - "description": "Latency for each epoch.", - "x-typespec-name": "float32[]" + } } - }, - "description": "Model status." + } }, "Multivariate.ModelStatus": { "type": "string", @@ -928,6 +918,7 @@ }, "Multivariate.MultivariateBatchDetectionOptions": { "type": "object", + "description": "Detection request for batch inference. This is an asynchronous inference that\nwill need another API to get detection results.", "properties": { "dataSource": { "type": "string", @@ -951,7 +942,6 @@ "description": "End date/time of data for detection, which should\nbe in ISO 8601 format." } }, - "description": "Detection request for batch inference. This is an asynchronous inference that\nwill need another API to get detection results.", "required": [ "dataSource", "startTime", @@ -960,6 +950,7 @@ }, "Multivariate.MultivariateBatchDetectionResultSummary": { "type": "object", + "description": "Multivariate anomaly detection status.", "properties": { "status": { "$ref": "#/definitions/Multivariate.MultivariateBatchDetectionStatus", @@ -967,28 +958,25 @@ }, "errors": { "type": "array", + "description": "Error message when detection fails.", "items": { "$ref": "#/definitions/Multivariate.ErrorResponse" }, - "x-ms-identifiers": [], - "description": "Error message when detection fails.", - "x-typespec-name": "Multivariate.ErrorResponse[]" + "x-ms-identifiers": [] }, "variableStates": { "type": "array", + "description": "Variable status.", "items": { "$ref": "#/definitions/Multivariate.VariableState" }, - "x-ms-identifiers": [], - "description": "Variable status.", - "x-typespec-name": "Multivariate.VariableState[]" + "x-ms-identifiers": [] }, "setupInfo": { "$ref": "#/definitions/Multivariate.MultivariateBatchDetectionOptions", "description": "Detection request for batch inference. This is an asynchronous inference that\nwill need another API to get detection results." } }, - "description": "Multivariate anomaly detection status.", "required": [ "status", "setupInfo" @@ -1027,11 +1015,12 @@ }, "Multivariate.MultivariateDetectionResult": { "type": "object", + "description": "Detection results for the resultId value.", "properties": { "resultId": { "type": "string", - "description": "Result identifier that's used to fetch the results of an inference call.", - "format": "uuid" + "format": "uuid", + "description": "Result identifier that's used to fetch the results of an inference call." }, "summary": { "$ref": "#/definitions/Multivariate.MultivariateBatchDetectionResultSummary", @@ -1039,15 +1028,13 @@ }, "results": { "type": "array", + "description": "Detection result for each time stamp.", "items": { "$ref": "#/definitions/Multivariate.AnomalyState" }, - "x-ms-identifiers": [], - "description": "Detection result for each time stamp.", - "x-typespec-name": "Multivariate.AnomalyState[]" + "x-ms-identifiers": [] } }, - "description": "Detection results for the resultId value.", "required": [ "resultId", "summary", @@ -1056,15 +1043,15 @@ }, "Multivariate.MultivariateLastDetectionOptions": { "type": "object", + "description": "Request of the last detection.", "properties": { "variables": { "type": "array", + "description": "Contains the inference data, including the name, time stamps (ISO 8601), and\nvalues of variables.", "items": { "$ref": "#/definitions/Multivariate.VariableValues" }, - "x-ms-identifiers": [], - "description": "Contains the inference data, including the name, time stamps (ISO 8601), and\nvalues of variables.", - "x-typespec-name": "Multivariate.VariableValues[]" + "x-ms-identifiers": [] }, "topContributorCount": { "type": "integer", @@ -1073,37 +1060,35 @@ "default": 10 } }, - "description": "Request of the last detection.", "required": [ "variables" ] }, "Multivariate.MultivariateLastDetectionResult": { "type": "object", + "description": "Results of the last detection.", "properties": { "variableStates": { "type": "array", + "description": "Variable status.", "items": { "$ref": "#/definitions/Multivariate.VariableState" }, - "x-ms-identifiers": [], - "description": "Variable status.", - "x-typespec-name": "Multivariate.VariableState[]" + "x-ms-identifiers": [] }, "results": { "type": "array", + "description": "Anomaly status and information.", "items": { "$ref": "#/definitions/Multivariate.AnomalyState" }, - "x-ms-identifiers": [], - "description": "Anomaly status and information.", - "x-typespec-name": "Multivariate.AnomalyState[]" + "x-ms-identifiers": [] } - }, - "description": "Results of the last detection." + } }, "Multivariate.ResponseError": { "type": "object", + "description": "Error response.", "properties": { "code": { "type": "string", @@ -1114,7 +1099,6 @@ "description": "Message that explains the error that the service reported." } }, - "description": "Error response.", "required": [ "code", "message" @@ -1122,6 +1106,7 @@ }, "Multivariate.VariableState": { "type": "object", + "description": "Variable status.", "properties": { "variable": { "type": "string", @@ -1149,11 +1134,11 @@ "format": "date-time", "description": "Last valid time stamp with a value of input data." } - }, - "description": "Variable status." + } }, "Multivariate.VariableValues": { "type": "object", + "description": "Variable values.", "properties": { "variable": { "type": "string", @@ -1161,23 +1146,20 @@ }, "timestamps": { "type": "array", + "description": "Time stamps of the last detection request.", "items": { "type": "string" - }, - "description": "Time stamps of the last detection request.", - "x-typespec-name": "string[]" + } }, "values": { "type": "array", + "description": "Values of variables.", "items": { "type": "number", "format": "float" - }, - "description": "Values of variables.", - "x-typespec-name": "float32[]" + } } }, - "description": "Variable values.", "required": [ "variable", "timestamps", @@ -1186,6 +1168,7 @@ }, "Univariate.AnomalyDetectorError": { "type": "object", + "description": "Error information that the API returned.", "properties": { "code": { "$ref": "#/definitions/Univariate.AnomalyDetectorErrorCodes", @@ -1196,7 +1179,6 @@ "description": "Message that explains the error that the service reported." } }, - "description": "Error information that the API returned.", "required": [ "code", "message" @@ -1321,6 +1303,7 @@ }, "Univariate.TimeSeriesPoint": { "type": "object", + "description": "Definition of input time series points.", "properties": { "timestamp": { "type": "string", @@ -1333,22 +1316,21 @@ "description": "Measurement of that point." } }, - "description": "Definition of input time series points.", "required": [ "value" ] }, "Univariate.UnivariateChangePointDetectionOptions": { "type": "object", + "description": "Request of change point detection.", "properties": { "series": { "type": "array", + "description": "Time series data points. Points should be sorted by time stamp in ascending\norder to match the change point detection result.", "items": { "$ref": "#/definitions/Univariate.TimeSeriesPoint" }, - "x-ms-identifiers": [], - "description": "Time series data points. Points should be sorted by time stamp in ascending\norder to match the change point detection result.", - "x-typespec-name": "Univariate.TimeSeriesPoint[]" + "x-ms-identifiers": [] }, "granularity": { "$ref": "#/definitions/Univariate.TimeGranularity", @@ -1375,7 +1357,6 @@ "description": "Argument that indicates an advanced model parameter between 0.0 and 1.0. The lower the\nvalue is, the larger the trend error is, which means less change point will\nbe accepted." } }, - "description": "Request of change point detection.", "required": [ "series", "granularity" @@ -1383,6 +1364,7 @@ }, "Univariate.UnivariateChangePointDetectionResult": { "type": "object", + "description": "Response of change point detection.", "properties": { "period": { "type": "integer", @@ -1392,35 +1374,32 @@ }, "isChangePoint": { "type": "array", + "description": "Change point properties for each input point. True means\nan anomaly (either negative or positive) has been detected. The index of the\narray is consistent with the input series.", "items": { "type": "boolean" - }, - "description": "Change point properties for each input point. True means\nan anomaly (either negative or positive) has been detected. The index of the\narray is consistent with the input series.", - "x-typespec-name": "boolean[]" + } }, "confidenceScores": { "type": "array", + "description": "Change point confidence of each point.", "items": { "type": "number", "format": "float" - }, - "description": "Change point confidence of each point.", - "x-typespec-name": "float32[]" + } } - }, - "description": "Response of change point detection." + } }, "Univariate.UnivariateDetectionOptions": { "type": "object", + "description": "Request of the entire or last anomaly detection.", "properties": { "series": { "type": "array", + "description": "Time series data points. Points should be sorted by time stamp in ascending\norder to match the anomaly detection result. If the data is not sorted\ncorrectly or there's a duplicated time stamp, the API won't work. In such\na case, an error message is returned.", "items": { "$ref": "#/definitions/Univariate.TimeSeriesPoint" }, - "x-ms-identifiers": [], - "description": "Time series data points. Points should be sorted by time stamp in ascending\norder to match the anomaly detection result. If the data is not sorted\ncorrectly or there's a duplicated time stamp, the API won't work. In such\na case, an error message is returned.", - "x-typespec-name": "Univariate.TimeSeriesPoint[]" + "x-ms-identifiers": [] }, "granularity": { "$ref": "#/definitions/Univariate.TimeGranularity", @@ -1456,13 +1435,13 @@ "description": "Specifies the value to fill. It's used when granularity is not \"none\"\nand imputeMode is \"fixed\"." } }, - "description": "Request of the entire or last anomaly detection.", "required": [ "series" ] }, "Univariate.UnivariateEntireDetectionResult": { "type": "object", + "description": "Response of the entire anomaly detection.", "properties": { "period": { "type": "integer", @@ -1471,66 +1450,58 @@ }, "expectedValues": { "type": "array", + "description": "Expected value for each input point. The index of the\narray is consistent with the input series.", "items": { "type": "number", "format": "float" - }, - "description": "Expected value for each input point. The index of the\narray is consistent with the input series.", - "x-typespec-name": "float32[]" + } }, "upperMargins": { "type": "array", + "description": "Upper margin of each input point. UpperMargin is used to\ncalculate upperBoundary, which is equal to expectedValue + (100 -\nmarginScale)*upperMargin. Anomalies in the response can be filtered by\nupperBoundary and lowerBoundary. Adjusting the marginScale value can help filter less\nsignificant anomalies on the client side. The index of the array is\nconsistent with the input series.", "items": { "type": "number", "format": "float" - }, - "description": "Upper margin of each input point. UpperMargin is used to\ncalculate upperBoundary, which is equal to expectedValue + (100 -\nmarginScale)*upperMargin. Anomalies in the response can be filtered by\nupperBoundary and lowerBoundary. Adjusting the marginScale value can help filter less\nsignificant anomalies on the client side. The index of the array is\nconsistent with the input series.", - "x-typespec-name": "float32[]" + } }, "lowerMargins": { "type": "array", + "description": "Lower margin of each input point. LowerMargin is used to\ncalculate lowerBoundary, which is equal to expectedValue - (100 -\nmarginScale)*lowerMargin. Points between the boundary can be marked as normal\nones on the client side. The index of the array is consistent with the input\nseries.", "items": { "type": "number", "format": "float" - }, - "description": "Lower margin of each input point. LowerMargin is used to\ncalculate lowerBoundary, which is equal to expectedValue - (100 -\nmarginScale)*lowerMargin. Points between the boundary can be marked as normal\nones on the client side. The index of the array is consistent with the input\nseries.", - "x-typespec-name": "float32[]" + } }, "isAnomaly": { "type": "array", + "description": "Anomaly properties for each input point. True means an\nanomaly (either negative or positive) has been detected. The index of the array\nis consistent with the input series.", "items": { "type": "boolean" - }, - "description": "Anomaly properties for each input point. True means an\nanomaly (either negative or positive) has been detected. The index of the array\nis consistent with the input series.", - "x-typespec-name": "boolean[]" + } }, "isNegativeAnomaly": { "type": "array", + "description": "Anomaly status in a negative direction for each input\npoint. True means a negative anomaly has been detected. A negative anomaly\nmeans the point is detected as an anomaly and its real value is smaller than\nthe expected one. The index of the array is consistent with the input series.", "items": { "type": "boolean" - }, - "description": "Anomaly status in a negative direction for each input\npoint. True means a negative anomaly has been detected. A negative anomaly\nmeans the point is detected as an anomaly and its real value is smaller than\nthe expected one. The index of the array is consistent with the input series.", - "x-typespec-name": "boolean[]" + } }, "isPositiveAnomaly": { "type": "array", + "description": "Anomaly status in a positive direction for each input\npoint. True means a positive anomaly has been detected. A positive anomaly\nmeans the point is detected as an anomaly and its real value is larger than the\nexpected one. The index of the array is consistent with the input series.", "items": { "type": "boolean" - }, - "description": "Anomaly status in a positive direction for each input\npoint. True means a positive anomaly has been detected. A positive anomaly\nmeans the point is detected as an anomaly and its real value is larger than the\nexpected one. The index of the array is consistent with the input series.", - "x-typespec-name": "boolean[]" + } }, "severity": { "type": "array", + "description": "Severity score for each input point. The larger the value is, the more\nsevere the anomaly is. For normal points, the severity is always 0.", "items": { "type": "number", "format": "float" - }, - "description": "Severity score for each input point. The larger the value is, the more\nsevere the anomaly is. For normal points, the severity is always 0.", - "x-typespec-name": "float32[]" + } } }, - "description": "Response of the entire anomaly detection.", "required": [ "period", "expectedValues", @@ -1543,6 +1514,7 @@ }, "Univariate.UnivariateLastDetectionResult": { "type": "object", + "description": "Response of the last anomaly detection.", "properties": { "period": { "type": "integer", @@ -1587,7 +1559,6 @@ "description": "Severity score for the last input point. The larger the value is, the more\nsevere the anomaly is. For normal points, the severity is always 0." } }, - "description": "Response of the last anomaly detection.", "required": [ "period", "suggestedWindow", @@ -1604,18 +1575,18 @@ "Azure.Core.SkipQueryParameter": { "name": "skip", "in": "query", - "required": false, "description": "The number of result items to skip.", - "default": 0, + "required": false, "type": "integer", "format": "int32", + "default": 0, "x-ms-parameter-location": "method" }, "Azure.Core.TopQueryParameter": { "name": "top", "in": "query", - "required": false, "description": "The number of result items to return.", + "required": false, "type": "integer", "format": "int32", "x-ms-parameter-location": "method" 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 2f4e00b9c8bd..cc8535b5e200 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 @@ -45,8 +45,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "api-key" + "name": "api-key", + "in": "header" }, "OAuth2Auth": { "type": "oauth2", @@ -70,17 +70,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -92,14 +92,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -121,17 +121,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -143,14 +143,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -172,17 +172,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" - }, - "required": true + } } ], "responses": { @@ -194,14 +194,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -223,36 +223,36 @@ { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" - }, - "required": true + } } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/BatchImageGenerationOperationResponse" + }, "headers": { "Operation-Location": { - "description": "The location for monitoring the operation state.", "type": "string", - "format": "uri" + "format": "uri", + "description": "The location for monitoring the operation state." } - }, - "schema": { - "$ref": "#/definitions/BatchImageGenerationOperationResponse" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -274,8 +274,8 @@ { "name": "operationId", "in": "path", - "required": true, "description": ".", + "required": true, "type": "string" } ], @@ -288,14 +288,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -310,6 +310,7 @@ "definitions": { "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -325,19 +326,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -345,19 +344,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -367,8 +367,7 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "AzureOpenAIOperationState": { "type": "string", @@ -414,6 +413,7 @@ }, "BatchImageGenerationOperationResponse": { "type": "object", + "description": "A polling status update or final response payload for an image operation.", "properties": { "id": { "type": "string", @@ -421,7 +421,7 @@ }, "created": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "A timestamp when this job or item was created (in unix epochs)." }, "expires": { @@ -442,7 +442,6 @@ "description": "The error if the operation failed." } }, - "description": "A polling status update or final response payload for an image operation.", "required": [ "id", "created", @@ -451,6 +450,7 @@ }, "ChatChoice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { "$ref": "#/definitions/ChatMessage", @@ -462,16 +462,21 @@ "description": "The ordered index associated with this chat completions choice." }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, "x-ms-client-name": "finishReason" }, "delta": { "$ref": "#/definitions/ChatMessage", "description": "The delta message content for a streaming response." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResults", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it \nhas been detected, as well as the severity level (very_low, low, medium, high-scale that \ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" } }, - "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "index", "finish_reason" @@ -479,6 +484,7 @@ }, "ChatCompletions": { "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -486,24 +492,31 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/ChatChoice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "ChatChoice[]" + "x-ms-identifiers": [] + }, + "prompt_annotations": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, \nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/PromptFilterResult" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -513,15 +526,15 @@ }, "ChatCompletionsOptions": { "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "messages": { "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { "$ref": "#/definitions/ChatMessage" }, - "x-ms-identifiers": [], - "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", - "x-typespec-name": "ChatMessage[]" + "x-ms-identifiers": [] }, "max_tokens": { "type": "integer", @@ -542,12 +555,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -561,11 +573,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -588,13 +599,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "messages" ] }, "ChatMessage": { "type": "object", + "description": "A single, role-attributed message within a chat completion interaction.", "properties": { "role": { "$ref": "#/definitions/ChatRole", @@ -602,12 +613,13 @@ }, "content": { "type": "string", - "description": "The text associated with this message payload." + "description": "The text associated with this message payload.", + "x-nullable": true } }, - "description": "A single, role-attributed message within a chat completion interaction.", "required": [ - "role" + "role", + "content" ] }, "ChatRole": { @@ -642,6 +654,7 @@ }, "Choice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "text": { "type": "string", @@ -652,24 +665,28 @@ "format": "int32", "description": "The ordered index associated with this completions choice." }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResults", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it \nhas been detected, as well as the severity level (very_low, low, medium, high-scale that \ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, "logprobs": { "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, "allOf": [ { "$ref": "#/definitions/CompletionsLogProbabilityModel" } - ], - "x-nullable": true, - "x-typespec-name": "CompletionsLogProbabilityModel | null", - "description": "The log probabilities model for tokens associated with this completions choice." + ] }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "Reason for finishing", + "x-nullable": true, "x-ms-client-name": "finishReason" } }, - "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "text", "index", @@ -679,6 +696,7 @@ }, "Completions": { "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -686,24 +704,31 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, + "prompt_annotations": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, \nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/PromptFilterResult" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/Choice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "Choice[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -711,52 +736,76 @@ "usage" ] }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + } + ] + } + }, "CompletionsLogProbabilityModel": { "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", "properties": { "tokens": { "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", "items": { "type": "string" - }, - "description": "The textual forms of tokens evaluated in this probability model.", - "x-typespec-name": "string[]" + } }, "token_logprobs": { "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", "items": { "type": "number", "format": "float", - "x-nullable": true, - "x-typespec-name": "float32 | null" + "x-nullable": true }, - "description": "A collection of log probability values for the tokens in this completions data.", - "x-typespec-name": "float32 | null[]", "x-ms-client-name": "tokenLogprobs" }, "top_logprobs": { "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", "items": { - "type": "object", - "x-typespec-name": "Record" + "type": "object" }, - "x-ms-identifiers": [], - "description": "A mapping of tokens to maximum log probability values in this completions data.", - "x-typespec-name": "Record[]", - "x-ms-client-name": "topLogprobs" + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] }, "text_offset": { "type": "array", + "description": "The text offsets associated with tokens in this completions data.", "items": { "type": "integer", "format": "int32" }, - "description": "The text offsets associated with tokens in this completions data.", - "x-typespec-name": "int32[]", "x-ms-client-name": "textOffset" } }, - "description": "Representation of a log probabilities model for a completions generation.", "required": [ "tokens", "token_logprobs", @@ -766,14 +815,14 @@ }, "CompletionsOptions": { "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "prompt": { "type": "array", + "description": "The prompts to generate completions from.", "items": { "type": "string" - }, - "description": "The prompts to generate completions from.", - "x-typespec-name": "string[]" + } }, "max_tokens": { "type": "integer", @@ -794,12 +843,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -822,11 +870,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -855,13 +902,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "prompt" ] }, "CompletionsUsage": { "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "properties": { "completion_tokens": { "type": "integer", @@ -882,24 +929,100 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "required": [ "completion_tokens", "prompt_tokens", "total_tokens" ] }, + "ContentFilterResult": { + "type": "object", + "description": "Information about filtered content severity level and if it has been filtered or not.", + "properties": { + "severity": { + "$ref": "#/definitions/ContentFilterSeverity", + "description": "Ratings for the intensity and risk level of filtered content." + }, + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + } + }, + "required": [ + "severity", + "filtered" + ] + }, + "ContentFilterResults": { + "type": "object", + "description": "Information about the content filtering category, if it has been detected.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including \n those portrayed as an assault or a forced sexual violent act against one’s will, \n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or \nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language \nwith reference to a person or identity group on the basis of certain differentiating \nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + } + } + }, + "ContentFilterSeverity": { + "type": "string", + "description": "Ratings for the intensity and risk level of harmful content.", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "name": "safe", + "value": "safe", + "description": "Content may be related to violence, self-harm, sexual, or hate categories but the terms \nare used in general, journalistic, scientific, medical, and similar professional contexts, \nwhich are appropriate for most audiences." + }, + { + "name": "low", + "value": "low", + "description": "Content that expresses prejudiced, judgmental, or opinionated views, includes offensive \nuse of language, stereotyping, use cases exploring a fictional world (for example, gaming,\nliterature) and depictions at low intensity." + }, + { + "name": "medium", + "value": "medium", + "description": "Content that uses offensive, insulting, mocking, intimidating, or demeaning language \ntowards specific identity groups, includes depictions of seeking and executing harmful \ninstructions, fantasies, glorification, promotion of harm at medium intensity." + }, + { + "name": "high", + "value": "high", + "description": "Content that displays explicit and severe harmful instructions, actions, \ndamage, or abuse; includes endorsement, glorification, or promotion of severe \nharmful acts, extreme or illegal forms of harm, radicalization, or non-consensual \npower exchange or abuse." + } + ] + } + }, "EmbeddingItem": { "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", "properties": { "embedding": { "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", "items": { "type": "number", "format": "float" - }, - "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", - "x-typespec-name": "float32[]" + } }, "index": { "type": "integer", @@ -907,7 +1030,6 @@ "description": "Index of the prompt to which the EmbeddingItem corresponds." } }, - "description": "Representation of a single embeddings relatedness comparison.", "required": [ "embedding", "index" @@ -915,22 +1037,21 @@ }, "Embeddings": { "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "data": { "type": "array", + "description": "Embedding values for the prompts submitted in the request.", "items": { "$ref": "#/definitions/EmbeddingItem" }, - "x-ms-identifiers": [], - "description": "Embedding values for the prompts submitted in the request.", - "x-typespec-name": "EmbeddingItem[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/EmbeddingsUsage", "description": "Usage counts for tokens input using the embeddings API." } }, - "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "data", "usage" @@ -938,6 +1059,7 @@ }, "EmbeddingsOptions": { "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "user": { "type": "string", @@ -949,20 +1071,19 @@ }, "input": { "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", "items": { "type": "string" - }, - "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", - "x-typespec-name": "string[]" + } } }, - "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "input" ] }, "EmbeddingsUsage": { "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", "properties": { "prompt_tokens": { "type": "integer", @@ -977,7 +1098,6 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Measurement of the amount of tokens used in this request and response.", "required": [ "prompt_tokens", "total_tokens" @@ -985,6 +1105,7 @@ }, "ImageGenerationOptions": { "type": "object", + "description": "Represents the request data used to generate images.", "properties": { "prompt": { "type": "string", @@ -1011,7 +1132,6 @@ "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse." } }, - "description": "Represents the request data used to generate images.", "required": [ "prompt" ] @@ -1042,18 +1162,17 @@ }, "ImageGenerations": { "type": "object", + "description": "The result of the operation if the operation succeeded.", "properties": { "created": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "A timestamp when this job or item was created (in unix epochs)." }, "data": { - "x-typespec-name": "ImageLocation[] | ImagePayload[]", "description": "The images generated by the operator." } }, - "description": "The result of the operation if the operation succeeded.", "required": [ "created", "data" @@ -1088,18 +1207,38 @@ } ] } + }, + "PromptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer", + "format": "int32", + "description": "The index of this prompt in the set of prompt results", + "x-ms-client-name": "promptIndex" + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResults", + "description": "Content filtering results for this prompt", + "x-ms-client-name": "contentFilterResults" + } + }, + "required": [ + "prompt_index" + ] } }, "parameters": { "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } 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 14d29e509a8c..2ddf16cdaf9b 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 @@ -45,8 +45,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "api-key" + "name": "api-key", + "in": "header" }, "OAuth2Auth": { "type": "oauth2", @@ -70,17 +70,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -92,14 +92,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -121,17 +121,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -143,14 +143,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -172,17 +172,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" - }, - "required": true + } } ], "responses": { @@ -194,14 +194,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -223,36 +223,36 @@ { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/ImageGenerationOptions" - }, - "required": true + } } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/BatchImageGenerationOperationResponse" + }, "headers": { "Operation-Location": { - "description": "The location for monitoring the operation state.", "type": "string", - "format": "uri" + "format": "uri", + "description": "The location for monitoring the operation state." } - }, - "schema": { - "$ref": "#/definitions/BatchImageGenerationOperationResponse" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -274,8 +274,8 @@ { "name": "operationId", "in": "path", - "required": true, "description": ".", + "required": true, "type": "string" } ], @@ -288,14 +288,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -310,6 +310,7 @@ "definitions": { "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -325,19 +326,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -345,19 +344,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -367,8 +367,7 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "AzureOpenAIOperationState": { "type": "string", @@ -414,6 +413,7 @@ }, "BatchImageGenerationOperationResponse": { "type": "object", + "description": "A polling status update or final response payload for an image operation.", "properties": { "id": { "type": "string", @@ -421,7 +421,7 @@ }, "created": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "A timestamp when this job or item was created (in unix epochs)." }, "expires": { @@ -442,7 +442,6 @@ "description": "The error if the operation failed." } }, - "description": "A polling status update or final response payload for an image operation.", "required": [ "id", "created", @@ -451,6 +450,7 @@ }, "ChatChoice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { "$ref": "#/definitions/ChatMessage", @@ -462,16 +462,21 @@ "description": "The ordered index associated with this chat completions choice." }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, "x-ms-client-name": "finishReason" }, "delta": { "$ref": "#/definitions/ChatMessage", "description": "The delta message content for a streaming response." + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResults", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it \nhas been detected, as well as the severity level (very_low, low, medium, high-scale that \ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" } }, - "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "index", "finish_reason" @@ -479,6 +484,7 @@ }, "ChatCompletions": { "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -486,24 +492,31 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/ChatChoice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "ChatChoice[]" + "x-ms-identifiers": [] + }, + "prompt_annotations": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, \nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/PromptFilterResult" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -513,27 +526,25 @@ }, "ChatCompletionsOptions": { "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "messages": { "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { "$ref": "#/definitions/ChatMessage" }, - "x-ms-identifiers": [], - "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", - "x-typespec-name": "ChatMessage[]" + "x-ms-identifiers": [] }, "functions": { "type": "array", + "description": "A list of functions the model may generate JSON inputs for.", "items": { "$ref": "#/definitions/FunctionDefinition" }, - "x-ms-identifiers": [], - "description": "A list of functions the model may generate JSON inputs for.", - "x-typespec-name": "FunctionDefinition[]" + "x-ms-identifiers": [] }, "function_call": { - "x-typespec-name": "FunctionCallPreset | FunctionName", "description": "Controls how the model responds to function calls. \"none\" means the model does not call a function,\nand responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.\n Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.", "x-ms-client-name": "functionCall" }, @@ -556,12 +567,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -575,11 +585,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -602,13 +611,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "messages" ] }, "ChatMessage": { "type": "object", + "description": "A single, role-attributed message within a chat completion interaction.", "properties": { "role": { "$ref": "#/definitions/ChatRole", @@ -616,7 +625,8 @@ }, "content": { "type": "string", - "description": "The text associated with this message payload." + "description": "The text associated with this message payload.", + "x-nullable": true }, "name": { "type": "string", @@ -628,9 +638,9 @@ "x-ms-client-name": "functionCall" } }, - "description": "A single, role-attributed message within a chat completion interaction.", "required": [ - "role" + "role", + "content" ] }, "ChatRole": { @@ -671,6 +681,7 @@ }, "Choice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "text": { "type": "string", @@ -681,24 +692,28 @@ "format": "int32", "description": "The ordered index associated with this completions choice." }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResults", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it \nhas been detected, as well as the severity level (very_low, low, medium, high-scale that \ndetermines the intensity and risk level of harmful content) and if it has been filtered or not.", + "x-ms-client-name": "contentFilterResults" + }, "logprobs": { "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, "allOf": [ { "$ref": "#/definitions/CompletionsLogProbabilityModel" } - ], - "x-nullable": true, - "x-typespec-name": "CompletionsLogProbabilityModel | null", - "description": "The log probabilities model for tokens associated with this completions choice." + ] }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "Reason for finishing", + "x-nullable": true, "x-ms-client-name": "finishReason" } }, - "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "text", "index", @@ -708,6 +723,7 @@ }, "Completions": { "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -715,24 +731,31 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, + "prompt_annotations": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, \nresults for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/definitions/PromptFilterResult" + }, + "x-ms-client-name": "promptFilterResults", + "x-ms-identifiers": [] + }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/Choice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "Choice[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -740,52 +763,82 @@ "usage" ] }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter", + "function_call" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + }, + { + "name": "functionCall", + "value": "function_call", + "description": "Completion ended normally, with the model requesting a function to be called." + } + ] + } + }, "CompletionsLogProbabilityModel": { "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", "properties": { "tokens": { "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", "items": { "type": "string" - }, - "description": "The textual forms of tokens evaluated in this probability model.", - "x-typespec-name": "string[]" + } }, "token_logprobs": { "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", "items": { "type": "number", "format": "float", - "x-nullable": true, - "x-typespec-name": "float32 | null" + "x-nullable": true }, - "description": "A collection of log probability values for the tokens in this completions data.", - "x-typespec-name": "float32 | null[]", "x-ms-client-name": "tokenLogprobs" }, "top_logprobs": { "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", "items": { - "type": "object", - "x-typespec-name": "Record" + "type": "object" }, - "x-ms-identifiers": [], - "description": "A mapping of tokens to maximum log probability values in this completions data.", - "x-typespec-name": "Record[]", - "x-ms-client-name": "topLogprobs" + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] }, "text_offset": { "type": "array", + "description": "The text offsets associated with tokens in this completions data.", "items": { "type": "integer", "format": "int32" }, - "description": "The text offsets associated with tokens in this completions data.", - "x-typespec-name": "int32[]", "x-ms-client-name": "textOffset" } }, - "description": "Representation of a log probabilities model for a completions generation.", "required": [ "tokens", "token_logprobs", @@ -795,14 +848,14 @@ }, "CompletionsOptions": { "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "prompt": { "type": "array", + "description": "The prompts to generate completions from.", "items": { "type": "string" - }, - "description": "The prompts to generate completions from.", - "x-typespec-name": "string[]" + } }, "max_tokens": { "type": "integer", @@ -823,12 +876,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -851,11 +903,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -884,13 +935,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "prompt" ] }, "CompletionsUsage": { "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "properties": { "completion_tokens": { "type": "integer", @@ -911,24 +962,100 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "required": [ "completion_tokens", "prompt_tokens", "total_tokens" ] }, + "ContentFilterResult": { + "type": "object", + "description": "Information about filtered content severity level and if it has been filtered or not.", + "properties": { + "severity": { + "$ref": "#/definitions/ContentFilterSeverity", + "description": "Ratings for the intensity and risk level of filtered content." + }, + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + } + }, + "required": [ + "severity", + "filtered" + ] + }, + "ContentFilterResults": { + "type": "object", + "description": "Information about the content filtering category, if it has been detected.", + "properties": { + "sexual": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to anatomical organs and genitals, romantic relationships,\n acts portrayed in erotic or affectionate terms, physical sexual acts, including \n those portrayed as an assault or a forced sexual violent act against one’s will, \n prostitution, pornography, and abuse." + }, + "violence": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to hurt, injure, damage, or \nkill someone or something; describes weapons, etc." + }, + "hate": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language attacks or uses that include pejorative or discriminatory language \nwith reference to a person or identity group on the basis of certain differentiating \nattributes of these groups including but not limited to race, ethnicity, nationality,\ngender identity and expression, sexual orientation, religion, immigration status, ability\nstatus, personal appearance, and body size." + }, + "self_harm": { + "$ref": "#/definitions/ContentFilterResult", + "description": "Describes language related to physical actions intended to purposely hurt, injure,\nor damage one’s body, or kill oneself.", + "x-ms-client-name": "selfHarm" + } + } + }, + "ContentFilterSeverity": { + "type": "string", + "description": "Ratings for the intensity and risk level of harmful content.", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "name": "safe", + "value": "safe", + "description": "Content may be related to violence, self-harm, sexual, or hate categories but the terms \nare used in general, journalistic, scientific, medical, and similar professional contexts, \nwhich are appropriate for most audiences." + }, + { + "name": "low", + "value": "low", + "description": "Content that expresses prejudiced, judgmental, or opinionated views, includes offensive \nuse of language, stereotyping, use cases exploring a fictional world (for example, gaming,\nliterature) and depictions at low intensity." + }, + { + "name": "medium", + "value": "medium", + "description": "Content that uses offensive, insulting, mocking, intimidating, or demeaning language \ntowards specific identity groups, includes depictions of seeking and executing harmful \ninstructions, fantasies, glorification, promotion of harm at medium intensity." + }, + { + "name": "high", + "value": "high", + "description": "Content that displays explicit and severe harmful instructions, actions, \ndamage, or abuse; includes endorsement, glorification, or promotion of severe \nharmful acts, extreme or illegal forms of harm, radicalization, or non-consensual \npower exchange or abuse." + } + ] + } + }, "EmbeddingItem": { "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", "properties": { "embedding": { "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", "items": { "type": "number", "format": "float" - }, - "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", - "x-typespec-name": "float32[]" + } }, "index": { "type": "integer", @@ -936,7 +1063,6 @@ "description": "Index of the prompt to which the EmbeddingItem corresponds." } }, - "description": "Representation of a single embeddings relatedness comparison.", "required": [ "embedding", "index" @@ -944,22 +1070,21 @@ }, "Embeddings": { "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "data": { "type": "array", + "description": "Embedding values for the prompts submitted in the request.", "items": { "$ref": "#/definitions/EmbeddingItem" }, - "x-ms-identifiers": [], - "description": "Embedding values for the prompts submitted in the request.", - "x-typespec-name": "EmbeddingItem[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/EmbeddingsUsage", "description": "Usage counts for tokens input using the embeddings API." } }, - "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "data", "usage" @@ -967,6 +1092,7 @@ }, "EmbeddingsOptions": { "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "user": { "type": "string", @@ -978,20 +1104,19 @@ }, "input": { "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", "items": { "type": "string" - }, - "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", - "x-typespec-name": "string[]" + } } }, - "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "input" ] }, "EmbeddingsUsage": { "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", "properties": { "prompt_tokens": { "type": "integer", @@ -1006,7 +1131,6 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Measurement of the amount of tokens used in this request and response.", "required": [ "prompt_tokens", "total_tokens" @@ -1014,6 +1138,7 @@ }, "FunctionCall": { "type": "object", + "description": "The name and arguments of a function that should be called, as generated by the model.", "properties": { "name": { "type": "string", @@ -1024,7 +1149,6 @@ "description": "The arguments to call the function with, as generated by the model in JSON format.\nNote that the model does not always generate valid JSON, and may hallucinate parameters\nnot defined by your function schema. Validate the arguments in your code before calling\nyour function." } }, - "description": "The name and arguments of a function that should be called, as generated by the model.", "required": [ "name", "arguments" @@ -1032,6 +1156,7 @@ }, "FunctionDefinition": { "type": "object", + "description": "The definition of a caller-specified function that chat completions may invoke in response to matching user input.", "properties": { "name": { "type": "string", @@ -1045,13 +1170,13 @@ "description": "The parameters the functions accepts, described as a JSON Schema object." } }, - "description": "The definition of a caller-specified function that chat completions may invoke in response to matching user input.", "required": [ "name" ] }, "ImageGenerationOptions": { "type": "object", + "description": "Represents the request data used to generate images.", "properties": { "prompt": { "type": "string", @@ -1078,7 +1203,6 @@ "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse." } }, - "description": "Represents the request data used to generate images.", "required": [ "prompt" ] @@ -1109,18 +1233,17 @@ }, "ImageGenerations": { "type": "object", + "description": "The result of the operation if the operation succeeded.", "properties": { "created": { "type": "integer", - "format": "int64", + "format": "unixtime", "description": "A timestamp when this job or item was created (in unix epochs)." }, "data": { - "x-typespec-name": "ImageLocation[] | ImagePayload[]", "description": "The images generated by the operator." } }, - "description": "The result of the operation if the operation succeeded.", "required": [ "created", "data" @@ -1155,18 +1278,38 @@ } ] } + }, + "PromptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer", + "format": "int32", + "description": "The index of this prompt in the set of prompt results", + "x-ms-client-name": "promptIndex" + }, + "content_filter_results": { + "$ref": "#/definitions/ContentFilterResults", + "description": "Content filtering results for this prompt", + "x-ms-client-name": "contentFilterResults" + } + }, + "required": [ + "prompt_index" + ] } }, "parameters": { "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json index 5ce1d80666c5..4817ba7a5ee3 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/generated.json @@ -45,8 +45,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "api-key" + "name": "api-key", + "in": "header" }, "OAuth2Auth": { "type": "oauth2", @@ -70,17 +70,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -92,14 +92,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -121,17 +121,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" - }, - "required": true + } } ], "responses": { @@ -143,14 +143,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -165,6 +165,7 @@ "definitions": { "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -180,19 +181,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -200,19 +199,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -222,11 +222,11 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "Choice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "text": { "type": "string", @@ -239,22 +239,21 @@ }, "logprobs": { "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, "allOf": [ { "$ref": "#/definitions/CompletionsLogProbabilityModel" } - ], - "x-nullable": true, - "x-typespec-name": "CompletionsLogProbabilityModel | null", - "description": "The log probabilities model for tokens associated with this completions choice." + ] }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "Reason for finishing", + "x-nullable": true, "x-ms-client-name": "finishReason" } }, - "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "text", "index", @@ -264,6 +263,7 @@ }, "Completions": { "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -271,24 +271,22 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/Choice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "Choice[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -296,52 +294,76 @@ "usage" ] }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + } + ] + } + }, "CompletionsLogProbabilityModel": { "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", "properties": { "tokens": { "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", "items": { "type": "string" - }, - "description": "The textual forms of tokens evaluated in this probability model.", - "x-typespec-name": "string[]" + } }, "token_logprobs": { "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", "items": { "type": "number", "format": "float", - "x-nullable": true, - "x-typespec-name": "float32 | null" + "x-nullable": true }, - "description": "A collection of log probability values for the tokens in this completions data.", - "x-typespec-name": "float32 | null[]", "x-ms-client-name": "tokenLogprobs" }, "top_logprobs": { "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", "items": { - "type": "object", - "x-typespec-name": "Record" + "type": "object" }, - "x-ms-identifiers": [], - "description": "A mapping of tokens to maximum log probability values in this completions data.", - "x-typespec-name": "Record[]", - "x-ms-client-name": "topLogprobs" + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] }, "text_offset": { "type": "array", + "description": "The text offsets associated with tokens in this completions data.", "items": { "type": "integer", "format": "int32" }, - "description": "The text offsets associated with tokens in this completions data.", - "x-typespec-name": "int32[]", "x-ms-client-name": "textOffset" } }, - "description": "Representation of a log probabilities model for a completions generation.", "required": [ "tokens", "token_logprobs", @@ -351,14 +373,14 @@ }, "CompletionsOptions": { "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "prompt": { "type": "array", + "description": "The prompts to generate completions from.", "items": { "type": "string" - }, - "description": "The prompts to generate completions from.", - "x-typespec-name": "string[]" + } }, "max_tokens": { "type": "integer", @@ -379,12 +401,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -407,11 +428,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -440,13 +460,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "prompt" ] }, "CompletionsUsage": { "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "properties": { "completion_tokens": { "type": "integer", @@ -467,7 +487,6 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "required": [ "completion_tokens", "prompt_tokens", @@ -476,15 +495,15 @@ }, "EmbeddingItem": { "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", "properties": { "embedding": { "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", "items": { "type": "number", "format": "float" - }, - "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", - "x-typespec-name": "float32[]" + } }, "index": { "type": "integer", @@ -492,7 +511,6 @@ "description": "Index of the prompt to which the EmbeddingItem corresponds." } }, - "description": "Representation of a single embeddings relatedness comparison.", "required": [ "embedding", "index" @@ -500,22 +518,21 @@ }, "Embeddings": { "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "data": { "type": "array", + "description": "Embedding values for the prompts submitted in the request.", "items": { "$ref": "#/definitions/EmbeddingItem" }, - "x-ms-identifiers": [], - "description": "Embedding values for the prompts submitted in the request.", - "x-typespec-name": "EmbeddingItem[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/EmbeddingsUsage", "description": "Usage counts for tokens input using the embeddings API." } }, - "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "data", "usage" @@ -523,6 +540,7 @@ }, "EmbeddingsOptions": { "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "user": { "type": "string", @@ -534,20 +552,19 @@ }, "input": { "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", "items": { "type": "string" - }, - "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", - "x-typespec-name": "string[]" + } } }, - "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "input" ] }, "EmbeddingsUsage": { "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", "properties": { "prompt_tokens": { "type": "integer", @@ -562,7 +579,6 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Measurement of the amount of tokens used in this request and response.", "required": [ "prompt_tokens", "total_tokens" @@ -573,12 +589,12 @@ "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json index 3ab19f89af3d..b7c515db0245 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/generated.json @@ -45,8 +45,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "api-key" + "name": "api-key", + "in": "header" }, "OAuth2Auth": { "type": "oauth2", @@ -70,17 +70,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/ChatCompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -92,14 +92,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -121,17 +121,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/CompletionsOptions" - }, - "required": true + } } ], "responses": { @@ -143,14 +143,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -172,17 +172,17 @@ { "name": "deploymentId", "in": "path", + "description": "Specifies either the model deployment name (when using Azure OpenAI) or model name (when using non-Azure OpenAI) to use for this request.", "required": true, - "description": "deployment id of the deployed model", "type": "string" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/EmbeddingsOptions" - }, - "required": true + } } ], "responses": { @@ -194,14 +194,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -216,6 +216,7 @@ "definitions": { "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -231,19 +232,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -251,19 +250,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -273,11 +273,11 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "ChatChoice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { "$ref": "#/definitions/ChatMessage", @@ -289,8 +289,9 @@ "description": "The ordered index associated with this chat completions choice." }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "The reason that this chat completions choice completed its generated.", + "x-nullable": true, "x-ms-client-name": "finishReason" }, "delta": { @@ -298,7 +299,6 @@ "description": "The delta message content for a streaming response." } }, - "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "index", "finish_reason" @@ -306,6 +306,7 @@ }, "ChatCompletions": { "type": "object", + "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -313,24 +314,22 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/ChatChoice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "ChatChoice[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -340,15 +339,15 @@ }, "ChatCompletionsOptions": { "type": "object", + "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "messages": { "type": "array", + "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { "$ref": "#/definitions/ChatMessage" }, - "x-ms-identifiers": [], - "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", - "x-typespec-name": "ChatMessage[]" + "x-ms-identifiers": [] }, "max_tokens": { "type": "integer", @@ -369,12 +368,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -388,11 +386,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -415,13 +412,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a chat completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "messages" ] }, "ChatMessage": { "type": "object", + "description": "A single, role-attributed message within a chat completion interaction.", "properties": { "role": { "$ref": "#/definitions/ChatRole", @@ -429,12 +426,13 @@ }, "content": { "type": "string", - "description": "The text associated with this message payload." + "description": "The text associated with this message payload.", + "x-nullable": true } }, - "description": "A single, role-attributed message within a chat completion interaction.", "required": [ - "role" + "role", + "content" ] }, "ChatRole": { @@ -469,6 +467,7 @@ }, "Choice": { "type": "object", + "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "text": { "type": "string", @@ -481,22 +480,21 @@ }, "logprobs": { "type": "object", + "description": "The log probabilities model for tokens associated with this completions choice.", + "x-nullable": true, "allOf": [ { "$ref": "#/definitions/CompletionsLogProbabilityModel" } - ], - "x-nullable": true, - "x-typespec-name": "CompletionsLogProbabilityModel | null", - "description": "The log probabilities model for tokens associated with this completions choice." + ] }, "finish_reason": { - "x-typespec-name": "CompletionsFinishReason | null", + "$ref": "#/definitions/CompletionsFinishReason", "description": "Reason for finishing", + "x-nullable": true, "x-ms-client-name": "finishReason" } }, - "description": "The representation of a single prompt completion as part of an overall completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "required": [ "text", "index", @@ -506,6 +504,7 @@ }, "Completions": { "type": "object", + "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "id": { "type": "string", @@ -513,24 +512,22 @@ }, "created": { "type": "integer", - "format": "int32", + "format": "unixtime", "description": "The first timestamp associated with generation activity for this completions response,\nrepresented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970." }, "choices": { "type": "array", + "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "items": { "$ref": "#/definitions/Choice" }, - "x-ms-identifiers": [], - "description": "The collection of completions choices associated with this completions response.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", - "x-typespec-name": "Choice[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/CompletionsUsage", "description": "Usage information for tokens processed and generated as part of this completions operation." } }, - "description": "Representation of the response data from a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "id", "created", @@ -538,52 +535,76 @@ "usage" ] }, + "CompletionsFinishReason": { + "type": "string", + "description": "Representation of the manner in which a completions response concluded.", + "enum": [ + "stop", + "length", + "content_filter" + ], + "x-ms-enum": { + "name": "CompletionsFinishReason", + "modelAsString": true, + "values": [ + { + "name": "stopped", + "value": "stop", + "description": "Completions ended normally and reached its end of token generation." + }, + { + "name": "tokenLimitReached", + "value": "length", + "description": "Completions exhausted available token limits before generation could complete." + }, + { + "name": "contentFiltered", + "value": "content_filter", + "description": "Completions generated a response that was identified as potentially sensitive per content\nmoderation policies." + } + ] + } + }, "CompletionsLogProbabilityModel": { "type": "object", + "description": "Representation of a log probabilities model for a completions generation.", "properties": { "tokens": { "type": "array", + "description": "The textual forms of tokens evaluated in this probability model.", "items": { "type": "string" - }, - "description": "The textual forms of tokens evaluated in this probability model.", - "x-typespec-name": "string[]" + } }, "token_logprobs": { "type": "array", + "description": "A collection of log probability values for the tokens in this completions data.", "items": { "type": "number", "format": "float", - "x-nullable": true, - "x-typespec-name": "float32 | null" + "x-nullable": true }, - "description": "A collection of log probability values for the tokens in this completions data.", - "x-typespec-name": "float32 | null[]", "x-ms-client-name": "tokenLogprobs" }, "top_logprobs": { "type": "array", + "description": "A mapping of tokens to maximum log probability values in this completions data.", "items": { - "type": "object", - "x-typespec-name": "Record" + "type": "object" }, - "x-ms-identifiers": [], - "description": "A mapping of tokens to maximum log probability values in this completions data.", - "x-typespec-name": "Record[]", - "x-ms-client-name": "topLogprobs" + "x-ms-client-name": "topLogprobs", + "x-ms-identifiers": [] }, "text_offset": { "type": "array", + "description": "The text offsets associated with tokens in this completions data.", "items": { "type": "integer", "format": "int32" }, - "description": "The text offsets associated with tokens in this completions data.", - "x-typespec-name": "int32[]", "x-ms-client-name": "textOffset" } }, - "description": "Representation of a log probabilities model for a completions generation.", "required": [ "tokens", "token_logprobs", @@ -593,14 +614,14 @@ }, "CompletionsOptions": { "type": "object", + "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "properties": { "prompt": { "type": "array", + "description": "The prompts to generate completions from.", "items": { "type": "string" - }, - "description": "The prompts to generate completions from.", - "x-typespec-name": "string[]" + } }, "max_tokens": { "type": "integer", @@ -621,12 +642,11 @@ }, "logit_bias": { "type": "object", + "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", "additionalProperties": { - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" }, - "description": "A map between GPT token IDs and bias scores that influences the probability of specific tokens\nappearing in a completions response. Token IDs are computed via external tokenizer tools, while\nbias scores reside in the range of -100 to 100 with minimum and maximum values corresponding to\na full ban or exclusive selection of a token, respectively. The exact behavior of a given bias\nscore varies by model.", - "x-typespec-name": "Record", "x-ms-client-name": "logitBias" }, "user": { @@ -649,11 +669,10 @@ }, "stop": { "type": "array", + "description": "A collection of textual sequences that will end completions generation.", "items": { "type": "string" - }, - "description": "A collection of textual sequences that will end completions generation.", - "x-typespec-name": "string[]" + } }, "presence_penalty": { "type": "number", @@ -682,13 +701,13 @@ "description": "The model name to provide as part of this completions request.\nNot applicable to Azure OpenAI, where deployment information should be included in the Azure\nresource URI that's connected to." } }, - "description": "The configuration information for a completions request.\nCompletions support a wide variety of tasks and generate text that continues from or \"completes\"\nprovided prompt data.", "required": [ "prompt" ] }, "CompletionsUsage": { "type": "object", + "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "properties": { "completion_tokens": { "type": "integer", @@ -709,7 +728,6 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Representation of the token counts processed for a completions request.\nCounts consider all tokens across prompts, choices, choice alternates, best_of generations, and\nother consumers.", "required": [ "completion_tokens", "prompt_tokens", @@ -718,15 +736,15 @@ }, "EmbeddingItem": { "type": "object", + "description": "Representation of a single embeddings relatedness comparison.", "properties": { "embedding": { "type": "array", + "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", "items": { "type": "number", "format": "float" - }, - "description": "List of embeddings value for the input prompt. These represent a measurement of the\nvector-based relatedness of the provided input.", - "x-typespec-name": "float32[]" + } }, "index": { "type": "integer", @@ -734,7 +752,6 @@ "description": "Index of the prompt to which the EmbeddingItem corresponds." } }, - "description": "Representation of a single embeddings relatedness comparison.", "required": [ "embedding", "index" @@ -742,22 +759,21 @@ }, "Embeddings": { "type": "object", + "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "data": { "type": "array", + "description": "Embedding values for the prompts submitted in the request.", "items": { "$ref": "#/definitions/EmbeddingItem" }, - "x-ms-identifiers": [], - "description": "Embedding values for the prompts submitted in the request.", - "x-typespec-name": "EmbeddingItem[]" + "x-ms-identifiers": [] }, "usage": { "$ref": "#/definitions/EmbeddingsUsage", "description": "Usage counts for tokens input using the embeddings API." } }, - "description": "Representation of the response data from an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "data", "usage" @@ -765,6 +781,7 @@ }, "EmbeddingsOptions": { "type": "object", + "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "properties": { "user": { "type": "string", @@ -776,20 +793,19 @@ }, "input": { "type": "array", + "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", "items": { "type": "string" - }, - "description": "Input texts to get embeddings for, encoded as a an array of strings.\nEach input must not exceed 2048 tokens in length.\n\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space,\nas we have observed inferior results when newlines are present.", - "x-typespec-name": "string[]" + } } }, - "description": "The configuration information for an embeddings request.\nEmbeddings measure the relatedness of text strings and are commonly used for search, clustering,\nrecommendations, and other similar scenarios.", "required": [ "input" ] }, "EmbeddingsUsage": { "type": "object", + "description": "Measurement of the amount of tokens used in this request and response.", "properties": { "prompt_tokens": { "type": "integer", @@ -804,7 +820,6 @@ "x-ms-client-name": "totalTokens" } }, - "description": "Measurement of the amount of tokens used in this request and response.", "required": [ "prompt_tokens", "total_tokens" @@ -815,12 +830,12 @@ "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json index ab2a5ad3e99d..7da0f7f59584 100644 --- a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json @@ -40,8 +40,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "Ocp-Apim-Subscription-Key" + "name": "Ocp-Apim-Subscription-Key", + "in": "header" } }, "tags": [], @@ -58,8 +58,8 @@ { "name": "body", "in": "body", - "required": true, "description": "The analysis request of the image.", + "required": true, "schema": { "$ref": "#/definitions/AnalyzeImageOptions" } @@ -74,14 +74,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -107,50 +107,47 @@ "description": "The request has succeeded.", "schema": { "type": "object", + "description": "Paged collection of TextBlocklist items", "properties": { "value": { "type": "array", + "description": "The TextBlocklist items on this page", "items": { "$ref": "#/definitions/TextBlocklist" }, - "x-ms-identifiers": [], - "description": "The TextBlocklist items on this page", - "x-typespec-name": "TextBlocklist[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of TextBlocklist items", "required": [ "value" - ], - "x-typespec-name": "Azure.Core.Foundations.CustomPage" + ] } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get All Text Blocklists": { "$ref": "./examples/ListTextBlocklists.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -166,11 +163,11 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" } ], "responses": { @@ -182,14 +179,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -203,6 +200,9 @@ "operationId": "TextBlocklists_CreateOrUpdateTextBlocklist", "summary": "Create Or Update Text Blocklist", "description": "Updates a text blocklist, if blocklistName does not exist, create a new blocklist.", + "consumes": [ + "application/merge-patch+json" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -210,17 +210,17 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" }, { "name": "resource", "in": "body", - "required": true, "description": "The resource instance.", + "required": true, "schema": { "$ref": "#/definitions/TextBlocklistUpdate" } @@ -241,20 +241,17 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/merge-patch+json" - ], "x-ms-examples": { "Create Or Update Text Blocklist": { "$ref": "./examples/CreateOrUpdateTextBlocklist.json" @@ -272,11 +269,11 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" } ], "responses": { @@ -285,14 +282,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -315,19 +312,19 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/AddBlockItemsOptions" - }, - "required": true + } } ], "responses": { @@ -339,14 +336,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -369,19 +366,19 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" }, { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/RemoveBlockItemsOptions" - }, - "required": true + } } ], "responses": { @@ -390,14 +387,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -420,11 +417,11 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" }, { "$ref": "#/parameters/Azure.Core.TopQueryParameter" @@ -441,50 +438,47 @@ "description": "The request has succeeded.", "schema": { "type": "object", + "description": "Paged collection of TextBlockItem items", "properties": { "value": { "type": "array", + "description": "The TextBlockItem items on this page", "items": { "$ref": "#/definitions/TextBlockItem" }, - "x-ms-identifiers": [], - "description": "The TextBlockItem items on this page", - "x-typespec-name": "TextBlockItem[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of TextBlockItem items", "required": [ "value" - ], - "x-typespec-name": "Azure.Core.Foundations.CustomPage" + ] } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get All BlockItems By blocklistName": { "$ref": "./examples/ListTextBlocklistItems.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -500,17 +494,17 @@ { "name": "blocklistName", "in": "path", - "required": true, "description": "Text blocklist name.", + "required": true, "type": "string", - "pattern": "^[0-9A-Za-z._~-]+$", - "maxLength": 64 + "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$" }, { "name": "blockItemId", "in": "path", - "required": true, "description": "Block Item Id. It will be uuid.", + "required": true, "type": "string", "maxLength": 64 } @@ -524,14 +518,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -554,8 +548,8 @@ { "name": "body", "in": "body", - "required": true, "description": "The request of text analysis.", + "required": true, "schema": { "$ref": "#/definitions/AnalyzeTextOptions" } @@ -570,14 +564,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -592,39 +586,38 @@ "definitions": { "AddBlockItemsOptions": { "type": "object", + "description": "The request of adding blockItems to text blocklist.", "properties": { "blockItems": { "type": "array", + "description": "Array of blockItemInfo to add.", "items": { "$ref": "#/definitions/TextBlockItemInfo" }, - "x-ms-identifiers": [], - "description": "Array of blockItemInfo to add.", - "x-typespec-name": "TextBlockItemInfo[]" + "x-ms-identifiers": [] } }, - "description": "The request of adding blockItems to text blocklist.", "required": [ "blockItems" ] }, "AddBlockItemsResult": { "type": "object", + "description": "The response of adding blockItems to text blocklist.", "properties": { "value": { "type": "array", + "description": "Array of blockItems added.", "items": { "$ref": "#/definitions/TextBlockItem" }, - "x-ms-identifiers": [], - "description": "Array of blockItems added.", - "x-typespec-name": "TextBlockItem[]" + "x-ms-identifiers": [] } - }, - "description": "The response of adding blockItems to text blocklist." + } }, "AnalyzeImageOptions": { "type": "object", + "description": "The analysis request of the image.", "properties": { "image": { "$ref": "#/definitions/ImageData", @@ -632,20 +625,19 @@ }, "categories": { "type": "array", + "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.", "items": { "$ref": "#/definitions/ImageCategory" - }, - "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.", - "x-typespec-name": "ImageCategory[]" + } } }, - "description": "The analysis request of the image.", "required": [ "image" ] }, "AnalyzeImageResult": { "type": "object", + "description": "The analysis response of the image.", "properties": { "hateResult": { "$ref": "#/definitions/ImageAnalyzeSeverityResult", @@ -663,11 +655,11 @@ "$ref": "#/definitions/ImageAnalyzeSeverityResult", "description": "Analysis result for Violence category." } - }, - "description": "The analysis response of the image." + } }, "AnalyzeTextOptions": { "type": "object", + "description": "The analysis request of the text.", "properties": { "text": { "type": "string", @@ -676,41 +668,38 @@ }, "categories": { "type": "array", + "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.", "items": { "$ref": "#/definitions/TextCategory" - }, - "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.", - "x-typespec-name": "TextCategory[]" + } }, "blocklistNames": { "type": "array", + "description": "The names of blocklists.", "items": { "type": "string" - }, - "description": "The names of blocklists.", - "x-typespec-name": "string[]" + } }, "breakByBlocklists": { "type": "boolean", "description": "When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit." } }, - "description": "The analysis request of the text.", "required": [ "text" ] }, "AnalyzeTextResult": { "type": "object", + "description": "The analysis response of the text", "properties": { "blocklistsMatchResults": { "type": "array", + "description": "The details of blocklist match.", "items": { "$ref": "#/definitions/TextBlocklistMatchResult" }, - "x-ms-identifiers": [], - "description": "The details of blocklist match.", - "x-typespec-name": "TextBlocklistMatchResult[]" + "x-ms-identifiers": [] }, "hateResult": { "$ref": "#/definitions/TextAnalyzeSeverityResult", @@ -728,11 +717,11 @@ "$ref": "#/definitions/TextAnalyzeSeverityResult", "description": "Analysis result for Violence category." } - }, - "description": "The analysis response of the text" + } }, "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -748,19 +737,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -768,19 +755,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -790,11 +778,11 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "ImageAnalyzeSeverityResult": { "type": "object", + "description": "Image analysis result.", "properties": { "category": { "$ref": "#/definitions/ImageCategory", @@ -806,7 +794,6 @@ "description": "The higher the severity of input content, the larger this value, currently its value could be: 0,2,4,6." } }, - "description": "Image analysis result.", "required": [ "category", "severity" @@ -828,6 +815,7 @@ }, "ImageData": { "type": "object", + "description": "The content or blob url of image, could be base64 encoding bytes or blob url. If both are given, the request will be refused. The maximum size of image is 2048 pixels * 2048 pixels, no larger than 4MB at the same time. The minimum size of image is 50 pixels * 50 pixels.", "properties": { "content": { "type": "string", @@ -839,28 +827,27 @@ "format": "uri", "description": "The blob url of image." } - }, - "description": "The content or blob url of image, could be base64 encoding bytes or blob url. If both are given, the request will be refused. The maximum size of image is 2048 pixels * 2048 pixels, no larger than 4MB at the same time. The minimum size of image is 50 pixels * 50 pixels." + } }, "RemoveBlockItemsOptions": { "type": "object", + "description": "The request of removing blockItems from text blocklist.", "properties": { "blockItemIds": { "type": "array", + "description": "Array of blockItemIds to remove.", "items": { "type": "string" - }, - "description": "Array of blockItemIds to remove.", - "x-typespec-name": "string[]" + } } }, - "description": "The request of removing blockItems from text blocklist.", "required": [ "blockItemIds" ] }, "TextAnalyzeSeverityResult": { "type": "object", + "description": "Text analysis result.", "properties": { "category": { "$ref": "#/definitions/TextCategory", @@ -872,7 +859,6 @@ "description": "The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6." } }, - "description": "Text analysis result.", "required": [ "category", "severity" @@ -880,6 +866,7 @@ }, "TextBlockItem": { "type": "object", + "description": "Item in TextBlocklist.", "properties": { "blockItemId": { "type": "string", @@ -901,7 +888,6 @@ "maxLength": 128 } }, - "description": "Item in TextBlocklist.", "required": [ "blockItemId", "text" @@ -909,6 +895,7 @@ }, "TextBlockItemInfo": { "type": "object", + "description": "Block item info in text blocklist.", "properties": { "description": { "type": "string", @@ -921,19 +908,19 @@ "maxLength": 128 } }, - "description": "Block item info in text blocklist.", "required": [ "text" ] }, "TextBlocklist": { "type": "object", + "description": "Text Blocklist.", "properties": { "blocklistName": { "type": "string", "description": "Text blocklist name.", - "pattern": "^[0-9A-Za-z._~-]+$", "maxLength": 64, + "pattern": "^[0-9A-Za-z._~-]+$", "x-ms-mutability": [ "read", "create" @@ -945,13 +932,13 @@ "maxLength": 1024 } }, - "description": "Text Blocklist.", "required": [ "blocklistName" ] }, "TextBlocklistMatchResult": { "type": "object", + "description": "The result of blocklist match.", "properties": { "blocklistName": { "type": "string", @@ -979,7 +966,6 @@ "description": "The length of matched text in original input." } }, - "description": "The result of blocklist match.", "required": [ "blocklistName", "blockItemId", @@ -990,14 +976,14 @@ }, "TextBlocklistUpdate": { "type": "object", + "description": "Text Blocklist.", "properties": { "description": { "type": "string", "description": "Text blocklist description.", "maxLength": 1024 } - }, - "description": "Text Blocklist." + } }, "TextCategory": { "type": "string", @@ -1034,18 +1020,18 @@ "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" }, "Azure.Core.MaxPageSizeQueryParameter": { "name": "maxpagesize", "in": "query", - "required": false, "description": "The maximum number of result items per page.", + "required": false, "type": "integer", "format": "int32", "x-ms-parameter-location": "method" @@ -1053,18 +1039,18 @@ "Azure.Core.SkipQueryParameter": { "name": "skip", "in": "query", - "required": false, "description": "The number of result items to skip.", - "default": 0, + "required": false, "type": "integer", "format": "int32", + "default": 0, "x-ms-parameter-location": "method" }, "Azure.Core.TopQueryParameter": { "name": "top", "in": "query", - "required": false, "description": "The number of result items to return.", + "required": false, "type": "integer", "format": "int32", "x-ms-parameter-location": "method" diff --git a/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json b/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json index b3c226255a51..95b328914fd6 100644 --- a/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json +++ b/specification/cognitiveservices/data-plane/HealthInsights/preview/2023-03-01-preview/openapi.json @@ -42,8 +42,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "Ocp-Apim-Subscription-Key" + "name": "Ocp-Apim-Subscription-Key", + "in": "header" } }, "tags": [ @@ -57,10 +57,10 @@ "paths": { "/oncophenotype/jobs": { "post": { + "operationId": "OncoPhenotype_CreateJob", "tags": [ "OncoPhenotype" ], - "operationId": "OncoPhenotype_CreateJob", "summary": "Create Onco Phenotype job", "description": "Creates an Onco Phenotype job with the given request body.", "parameters": [ @@ -76,10 +76,10 @@ { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/OncoPhenotypeData" - }, - "required": true + } } ], "responses": { @@ -93,18 +93,18 @@ "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Operation-Location": { - "description": "The location for monitoring the operation state.", "type": "string", - "format": "uri" + "format": "uri", + "description": "The location for monitoring the operation state." }, "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Repeatability-Result": { - "description": "Indicates whether the repeatable request was accepted or rejected.", "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", "enum": [ "accepted", "rejected" @@ -114,14 +114,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -134,10 +134,10 @@ }, "/oncophenotype/jobs/{jobId}": { "get": { + "operationId": "OncoPhenotype_GetJob", "tags": [ "OncoPhenotype" ], - "operationId": "OncoPhenotype_GetJob", "summary": "Get Onco Phenotype job details", "description": "Gets the status and details of the Onco Phenotype job.", "parameters": [ @@ -147,8 +147,8 @@ { "name": "jobId", "in": "path", - "required": true, "description": "A processing job identifier.", + "required": true, "type": "string", "format": "uuid" } @@ -162,14 +162,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -182,10 +182,10 @@ }, "/trialmatcher/jobs": { "post": { + "operationId": "TrialMatcher_CreateJob", "tags": [ "TrialMatcher" ], - "operationId": "TrialMatcher_CreateJob", "summary": "Create Trial Matcher job", "description": "Creates a Trial Matcher job with the given request body.", "parameters": [ @@ -201,10 +201,10 @@ { "name": "body", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/TrialMatcherData" - }, - "required": true + } } ], "responses": { @@ -218,18 +218,18 @@ "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Operation-Location": { - "description": "The location for monitoring the operation state.", "type": "string", - "format": "uri" + "format": "uri", + "description": "The location for monitoring the operation state." }, "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Repeatability-Result": { - "description": "Indicates whether the repeatable request was accepted or rejected.", "type": "string", + "description": "Indicates whether the repeatable request was accepted or rejected.", "enum": [ "accepted", "rejected" @@ -239,14 +239,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -259,10 +259,10 @@ }, "/trialmatcher/jobs/{jobId}": { "get": { + "operationId": "TrialMatcher_GetJob", "tags": [ "TrialMatcher" ], - "operationId": "TrialMatcher_GetJob", "summary": "Get Trial Matcher job details", "description": "Gets the status and details of the Trial Matcher job.", "parameters": [ @@ -272,8 +272,8 @@ { "name": "jobId", "in": "path", - "required": true, "description": "A processing job identifier.", + "required": true, "type": "string", "format": "uuid" } @@ -287,14 +287,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -309,6 +309,7 @@ "definitions": { "AcceptedAge": { "type": "object", + "description": "A person's age, given as a number (value) and a unit (e.g. years, months)", "properties": { "unit": { "$ref": "#/definitions/AgeUnit", @@ -320,7 +321,6 @@ "description": "The number of years/months/days that represents the person's age." } }, - "description": "A person's age, given as a number (value) and a unit (e.g. years, months)", "required": [ "unit", "value" @@ -328,6 +328,7 @@ }, "AcceptedAgeRange": { "type": "object", + "description": "A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age.", "properties": { "minimumAge": { "$ref": "#/definitions/AcceptedAge", @@ -337,8 +338,7 @@ "$ref": "#/definitions/AcceptedAge", "description": "A person's age, given as a number (value) and a unit (e.g. years, months)" } - }, - "description": "A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age." + } }, "AgeUnit": { "type": "string", @@ -385,6 +385,7 @@ }, "AreaGeometry": { "type": "object", + "description": "`GeoJSON` geometry, representing the area circle's center.", "properties": { "type": { "$ref": "#/definitions/GeoJsonGeometryType", @@ -392,17 +393,15 @@ }, "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" - }, - "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).", - "x-typespec-name": "float32[]", - "minItems": 2, - "maxItems": 2 + } } }, - "description": "`GeoJSON` geometry, representing the area circle's center.", "required": [ "type", "coordinates" @@ -410,6 +409,7 @@ }, "AreaProperties": { "type": "object", + "description": "`GeoJSON` object properties.", "properties": { "subType": { "$ref": "#/definitions/GeoJsonPropertiesSubType", @@ -421,7 +421,6 @@ "description": "The radius of the area's circle, in meters." } }, - "description": "`GeoJSON` object properties.", "required": [ "subType", "radius" @@ -429,6 +428,7 @@ }, "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -444,19 +444,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -464,19 +462,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -486,11 +485,11 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "ClinicalCodedElement": { "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system.", "properties": { "system": { "type": "string", @@ -509,7 +508,6 @@ "description": "A value associated with the code within the given clinical coding system." } }, - "description": "A piece of clinical information, expressed as a code in a clinical coding system.", "required": [ "system", "code" @@ -569,6 +567,7 @@ }, "ClinicalNoteEvidence": { "type": "object", + "description": "A piece of evidence from a clinical note (text document).", "properties": { "id": { "type": "string", @@ -591,7 +590,6 @@ "minimum": 1 } }, - "description": "A piece of evidence from a clinical note (text document).", "required": [ "id", "offset", @@ -627,6 +625,7 @@ }, "ClinicalTrialDemographics": { "type": "object", + "description": "Demographic criteria for a clinical trial.", "properties": { "acceptedSex": { "$ref": "#/definitions/ClinicalTrialAcceptedSex", @@ -636,11 +635,11 @@ "$ref": "#/definitions/AcceptedAgeRange", "description": "A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age." } - }, - "description": "Demographic criteria for a clinical trial." + } }, "ClinicalTrialDetails": { "type": "object", + "description": "A description of a clinical trial.", "properties": { "id": { "type": "string", @@ -660,7 +659,6 @@ "description": "Trial data which is of interest to the potential participant." } }, - "description": "A description of a clinical trial.", "required": [ "id", "metadata" @@ -668,14 +666,14 @@ }, "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" - }, - "description": "Phases which are relevant for the clinical trial.\nEach clinical trial can be in a certain phase or in multiple phases.", - "x-typespec-name": "ClinicalTrialPhase[]" + } }, "studyType": { "$ref": "#/definitions/ClinicalTrialStudyType", @@ -687,41 +685,36 @@ }, "conditions": { "type": "array", + "description": "Medical conditions and their synonyms which are relevant for the clinical trial, given as strings.", + "minItems": 1, "items": { "type": "string" - }, - "description": "Medical conditions and their synonyms which are relevant for the clinical trial, given as strings.", - "x-typespec-name": "string[]", - "minItems": 1 + } }, "sponsors": { "type": "array", + "description": "Sponsors/collaborators involved with the trial.", "items": { "type": "string" - }, - "description": "Sponsors/collaborators involved with the trial.", - "x-typespec-name": "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": [], - "description": "Contact details of the trial administrators, for patients that want to participate in the trial.", - "x-typespec-name": "ContactDetails[]" + "x-ms-identifiers": [] }, "facilities": { "type": "array", + "description": "Research facilities where the clinical trial is conducted.", "items": { "$ref": "#/definitions/ClinicalTrialResearchFacility" }, - "x-ms-identifiers": [], - "description": "Research facilities where the clinical trial is conducted.", - "x-typespec-name": "ClinicalTrialResearchFacility[]" + "x-ms-identifiers": [] } }, - "description": "Trial data which is of interest to the potential participant.", "required": [ "conditions" ] @@ -864,102 +857,92 @@ }, "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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" - }, - "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.", - "x-typespec-name": "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": [], - "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.", - "x-typespec-name": "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": [], - "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.", - "x-typespec-name": "GeographicArea[]" + "x-ms-identifiers": [] } - }, - "description": "A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov)." + } }, "ClinicalTrialResearchFacility": { "type": "object", + "description": "Details of a research facility where a clinical trial is conducted.", "properties": { "name": { "type": "string", @@ -978,7 +961,6 @@ "description": "Country/region name." } }, - "description": "Details of a research facility where a clinical trial is conducted.", "required": [ "name", "countryOrRegion" @@ -1040,31 +1022,30 @@ }, "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/ClinicalTrialDetails" - }, - "description": "A list of clinical trials.", - "x-typespec-name": "ClinicalTrialDetails[]", - "minItems": 1 + } }, "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": [], - "description": "A list of filters, each one creating a selection of trials from a given\nclinical trial registry.", - "x-typespec-name": "ClinicalTrialRegistryFilter[]", - "minItems": 1 + "x-ms-identifiers": [] } - }, - "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." + } }, "ContactDetails": { "type": "object", + "description": "A person's contact details.", "properties": { "name": { "type": "string", @@ -1078,11 +1059,11 @@ "type": "string", "description": "A person's phone number." } - }, - "description": "A person's contact details." + } }, "DocumentContent": { "type": "object", + "description": "The content of the patient document.", "properties": { "sourceType": { "$ref": "#/definitions/DocumentContentSourceType", @@ -1093,7 +1074,6 @@ "description": "The content of the document, given either inline (as a string) or as a reference (URI)." } }, - "description": "The content of the patient document.", "required": [ "sourceType", "value" @@ -1155,6 +1135,7 @@ }, "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", @@ -1181,7 +1162,6 @@ "description": "The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination." } }, - "description": "A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information.", "required": [ "system", "code" @@ -1240,6 +1220,7 @@ }, "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", @@ -1254,7 +1235,6 @@ "description": "`GeoJSON` object properties." } }, - "description": "A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)).", "required": [ "type", "geometry", @@ -1263,6 +1243,7 @@ }, "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", @@ -1277,13 +1258,13 @@ "description": "Country/region name." } }, - "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.", "required": [ "countryOrRegion" ] }, "Inference": { "type": "object", + "description": "An inference made by the model regarding a patient.", "properties": { "value": { "type": "string", @@ -1301,13 +1282,13 @@ "maximum": 1 } }, - "description": "An inference made by the model regarding a patient.", "required": [ "value" ] }, "InferenceEvidence": { "type": "object", + "description": "A piece of evidence corresponding to an inference.", "properties": { "patientDataEvidence": { "$ref": "#/definitions/ClinicalNoteEvidence", @@ -1324,8 +1305,7 @@ "minimum": 0, "maximum": 1 } - }, - "description": "A piece of evidence corresponding to an inference." + } }, "JobStatus": { "type": "string", @@ -1370,35 +1350,35 @@ }, "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": [], - "description": "Clinical information which is needed to provide better trial matching results for the patient." + "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" - }, - "description": "The list of patients, including their clinical information and data.", - "x-typespec-name": "PatientRecord[]" + } }, "configuration": { "$ref": "#/definitions/OncoPhenotypeModelConfiguration", "description": "Configuration affecting the Onco Phenotype model's inference." } }, - "description": "The body of the Onco Phenotype request.", "required": [ "patients" ] }, "OncoPhenotypeInference": { "type": "object", + "description": "An inference made by the Onco Phenotype model regarding a patient.", "properties": { "type": { "$ref": "#/definitions/OncoPhenotypeInferenceType", @@ -1421,19 +1401,17 @@ }, "evidence": { "type": "array", + "description": "The evidence corresponding to the inference value.", "items": { "$ref": "#/definitions/InferenceEvidence" }, - "x-ms-identifiers": [], - "description": "The evidence corresponding to the inference value.", - "x-typespec-name": "InferenceEvidence[]" + "x-ms-identifiers": [] }, "caseId": { "type": "string", "description": "An identifier for a clinical case, if there are multiple clinical cases regarding the same patient." } }, - "description": "An inference made by the Onco Phenotype model regarding a patient.", "required": [ "type", "value" @@ -1493,6 +1471,7 @@ }, "OncoPhenotypeModelConfiguration": { "type": "object", + "description": "Configuration affecting the Onco Phenotype model's inference.", "properties": { "verbose": { "type": "boolean", @@ -1506,22 +1485,21 @@ }, "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" - }, - "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.", - "x-typespec-name": "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 } - }, - "description": "Configuration affecting the Onco Phenotype model's inference." + } }, "OncoPhenotypePatientResult": { "type": "object", + "description": "The results of the model's work for a single patient.", "properties": { "id": { "type": "string", @@ -1529,15 +1507,13 @@ }, "inferences": { "type": "array", + "description": "The model's inferences for the given patient.", "items": { "$ref": "#/definitions/OncoPhenotypeInference" }, - "x-ms-identifiers": [], - "description": "The model's inferences for the given patient.", - "x-typespec-name": "OncoPhenotypeInference[]" + "x-ms-identifiers": [] } }, - "description": "The results of the model's work for a single patient.", "required": [ "id", "inferences" @@ -1545,11 +1521,12 @@ }, "OncoPhenotypeResult": { "type": "object", + "description": "The response for the Onco Phenotype request.", "properties": { "jobId": { "type": "string", - "description": "A processing job identifier.", "format": "uuid", + "description": "A processing job identifier.", "readOnly": true }, "createdDateTime": { @@ -1577,13 +1554,12 @@ }, "errors": { "type": "array", + "description": "An array of errors, if any errors occurred during the processing job.", "items": { "$ref": "#/definitions/Azure.Core.Foundations.Error" }, - "x-ms-identifiers": [], - "description": "An array of errors, if any errors occurred during the processing job.", - "x-typespec-name": "Azure.Core.Foundations.Error[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "results": { "$ref": "#/definitions/OncoPhenotypeResults", @@ -1591,7 +1567,6 @@ "readOnly": true } }, - "description": "The response for the Onco Phenotype request.", "required": [ "jobId", "createdDateTime", @@ -1602,21 +1577,20 @@ }, "OncoPhenotypeResults": { "type": "object", + "description": "The inference results for the Onco Phenotype request.", "properties": { "patients": { "type": "array", + "description": "Results for the patients given in the request.", "items": { "$ref": "#/definitions/OncoPhenotypePatientResult" - }, - "description": "Results for the patients given in the request.", - "x-typespec-name": "OncoPhenotypePatientResult[]" + } }, "modelVersion": { "$ref": "#/definitions/ModelVersion", "description": "The version of the model used for inference, expressed as the model date." } }, - "description": "The inference results for the Onco Phenotype request.", "required": [ "patients", "modelVersion" @@ -1624,6 +1598,7 @@ }, "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", @@ -1652,7 +1627,6 @@ "description": "The content of the patient document." } }, - "description": "A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).", "required": [ "type", "id", @@ -1661,6 +1635,7 @@ }, "PatientInfo": { "type": "object", + "description": "Patient structured information, including demographics and known structured clinical information.", "properties": { "sex": { "$ref": "#/definitions/PatientInfoSex", @@ -1673,15 +1648,13 @@ }, "clinicalInfo": { "type": "array", + "description": "Known clinical information for the patient, structured.", "items": { "$ref": "#/definitions/ClinicalCodedElement" }, - "x-ms-identifiers": [], - "description": "Known clinical information for the patient, structured.", - "x-typespec-name": "ClinicalCodedElement[]" + "x-ms-identifiers": [] } - }, - "description": "Patient structured information, including demographics and known structured clinical information." + } }, "PatientInfoSex": { "type": "string", @@ -1712,6 +1685,7 @@ }, "PatientRecord": { "type": "object", + "description": "A patient record, including their clinical information and data.", "properties": { "id": { "type": "string", @@ -1724,41 +1698,39 @@ }, "data": { "type": "array", + "description": "Patient unstructured clinical data, given as documents.", "items": { "$ref": "#/definitions/PatientDocument" - }, - "description": "Patient unstructured clinical data, given as documents.", - "x-typespec-name": "PatientDocument[]" + } } }, - "description": "A patient record, including their clinical information and data.", "required": [ "id" ] }, "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" - }, - "description": "The list of patients, including their clinical information and data.", - "x-typespec-name": "PatientRecord[]" + } }, "configuration": { "$ref": "#/definitions/TrialMatcherModelConfiguration", "description": "Configuration affecting the Trial Matcher model's inference." } }, - "description": "The body of the Trial Matcher request.", "required": [ "patients" ] }, "TrialMatcherInference": { "type": "object", + "description": "An inference made by the Trial Matcher model regarding a patient.", "properties": { "type": { "$ref": "#/definitions/TrialMatcherInferenceType", @@ -1781,12 +1753,11 @@ }, "evidence": { "type": "array", + "description": "The evidence corresponding to the inference value.", "items": { "$ref": "#/definitions/TrialMatcherInferenceEvidence" }, - "x-ms-identifiers": [], - "description": "The evidence corresponding to the inference value.", - "x-typespec-name": "TrialMatcherInferenceEvidence[]" + "x-ms-identifiers": [] }, "id": { "type": "string", @@ -1802,7 +1773,6 @@ "description": "Trial data which is of interest to the potential participant." } }, - "description": "An inference made by the Trial Matcher model regarding a patient.", "required": [ "type", "value" @@ -1810,6 +1780,7 @@ }, "TrialMatcherInferenceEvidence": { "type": "object", + "description": "A piece of evidence corresponding to a Trial Matcher inference.", "properties": { "eligibilityCriteriaEvidence": { "type": "string", @@ -1830,8 +1801,7 @@ "minimum": 0, "maximum": 1 } - }, - "description": "A piece of evidence corresponding to a Trial Matcher inference." + } }, "TrialMatcherInferenceType": { "type": "string", @@ -1852,6 +1822,7 @@ }, "TrialMatcherModelConfiguration": { "type": "object", + "description": "Configuration affecting the Trial Matcher model's inference.", "properties": { "verbose": { "type": "boolean", @@ -1868,13 +1839,13 @@ "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." } }, - "description": "Configuration affecting the Trial Matcher model's inference.", "required": [ "clinicalTrials" ] }, "TrialMatcherPatientResult": { "type": "object", + "description": "The results of the model's work for a single patient.", "properties": { "id": { "type": "string", @@ -1882,18 +1853,16 @@ }, "inferences": { "type": "array", + "description": "The model's inferences for the given patient.", "items": { "$ref": "#/definitions/TrialMatcherInference" - }, - "description": "The model's inferences for the given patient.", - "x-typespec-name": "TrialMatcherInference[]" + } }, "neededClinicalInfo": { "$ref": "#/definitions/NeededClinicalInfo", "description": "Clinical information which is needed to provide better trial matching results for the patient." } }, - "description": "The results of the model's work for a single patient.", "required": [ "id", "inferences" @@ -1901,11 +1870,12 @@ }, "TrialMatcherResult": { "type": "object", + "description": "The response for the Trial Matcher request.", "properties": { "jobId": { "type": "string", - "description": "A processing job identifier.", "format": "uuid", + "description": "A processing job identifier.", "readOnly": true }, "createdDateTime": { @@ -1933,13 +1903,12 @@ }, "errors": { "type": "array", + "description": "An array of errors, if any errors occurred during the processing job.", "items": { "$ref": "#/definitions/Azure.Core.Foundations.Error" }, - "x-ms-identifiers": [], - "description": "An array of errors, if any errors occurred during the processing job.", - "x-typespec-name": "Azure.Core.Foundations.Error[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "results": { "$ref": "#/definitions/TrialMatcherResults", @@ -1947,7 +1916,6 @@ "readOnly": true } }, - "description": "The response for the Trial Matcher request.", "required": [ "jobId", "createdDateTime", @@ -1958,14 +1926,14 @@ }, "TrialMatcherResults": { "type": "object", + "description": "The inference results for the Trial Matcher request.", "properties": { "patients": { "type": "array", + "description": "Results for the patients given in the request.", "items": { "$ref": "#/definitions/TrialMatcherPatientResult" - }, - "description": "Results for the patients given in the request.", - "x-typespec-name": "TrialMatcherPatientResult[]" + } }, "modelVersion": { "$ref": "#/definitions/ModelVersion", @@ -1977,7 +1945,6 @@ "description": "The date when the clinical trials knowledge graph was last updated." } }, - "description": "The inference results for the Trial Matcher request.", "required": [ "patients", "modelVersion" @@ -1988,31 +1955,31 @@ "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" }, "Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent": { "name": "Repeatability-First-Sent", "in": "header", - "required": false, "description": "Specifies the date and time at which the request was first created.", - "x-ms-client-name": "repeatabilityFirstSent", + "required": false, "type": "string", "format": "date-time", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "repeatabilityFirstSent" }, "Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId": { "name": "Repeatability-Request-ID", "in": "header", - "required": false, "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "x-ms-client-name": "repeatabilityRequestId", + "required": false, "type": "string", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "repeatabilityRequestId" } } } diff --git a/specification/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json b/specification/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json index c8d73b0dac41..03b0aa1c017d 100644 --- a/specification/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json +++ b/specification/communication/data-plane/Identity/stable/2023-08-01/CommunicationIdentity.json @@ -133,20 +133,6 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "header", - "name": "Repeatability-Request-ID", - "description": "If specified, the client directs that the request is repeatable; that is, that 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, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. Internal identifiers shouldn't be used. The value should be an opaque meaningless string in UUID format.", - "type": "string", - "format": "uuid" - }, - { - "in": "header", - "name": "Repeatability-First-Sent", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date", - "type": "string", - "format": "date-time-rfc1123" } ], "responses": { @@ -157,17 +143,11 @@ } }, "204": { - "description": "No Content", - "headers": { - "Repeatability-Result": { - "description": "Result of idempotent request. Present only in case of idempotent processing.", - "type": "string" - } - } + "description": "No Content" } }, "x-ms-examples": { - "Revoke access tokens with optional idempotent processing using Repeatability-Request-ID and Repeatability-First-Sent headers. If the headers are not provided, the request will be processed in a non-idempotent way which can lead to more tokens being revoked than intended on a retry.": { + "Revoke access tokens": { "$ref": "./examples/RevokeAccessTokens.json" } } diff --git a/specification/communication/data-plane/Identity/stable/2023-08-01/examples/RevokeAccessTokens.json b/specification/communication/data-plane/Identity/stable/2023-08-01/examples/RevokeAccessTokens.json index 1a6910eb229f..8f005c3926a1 100644 --- a/specification/communication/data-plane/Identity/stable/2023-08-01/examples/RevokeAccessTokens.json +++ b/specification/communication/data-plane/Identity/stable/2023-08-01/examples/RevokeAccessTokens.json @@ -3,17 +3,9 @@ "api-version": "2023-08-01", "content-type": "application/json", "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081", - "endpoint": "https://my-resource.communication.azure.com", - "headers": { - "Repeatability-Request-ID": "4e7d453c-ae97-4778-ad51-cb3b4a701100", - "Repeatability-First-Sent": "Sun, 10 Sep 2023 20:39:30 GMT" - } + "endpoint": "https://my-resource.communication.azure.com" }, "responses": { - "204": { - "headers": { - "Repeatability-Result": "accepted" - } - } + "204": {} } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json index 52dc6d82e376..2be2857afdbf 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/communicationservicejobrouter.json @@ -23,7 +23,7 @@ { "in": "path", "name": "id", - "description": "Id of the classification policy", + "description": "Id of the classification policy.", "required": true, "type": "string" }, @@ -33,7 +33,7 @@ { "in": "body", "name": "patch", - "description": "Model of classification policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of classification policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/ClassificationPolicy" @@ -41,17 +41,23 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/ClassificationPolicy" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/ClassificationPolicy" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -67,7 +73,7 @@ "tags": [ "ClassificationPolicies" ], - "summary": "Retrieves an existing classification policy by Id", + "summary": "Retrieves an existing classification policy by Id.", "operationId": "JobRouterAdministration_GetClassificationPolicy", "produces": [ "application/json" @@ -76,7 +82,7 @@ { "in": "path", "name": "id", - "description": "Id of the classification policy", + "description": "Id of the classification policy.", "required": true, "type": "string" }, @@ -85,17 +91,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/ClassificationPolicy" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -108,7 +114,7 @@ "tags": [ "ClassificationPolicies" ], - "summary": "Delete a classification policy by Id", + "summary": "Delete a classification policy by Id.", "operationId": "JobRouterAdministration_DeleteClassificationPolicy", "produces": [ "application/json" @@ -117,7 +123,7 @@ { "in": "path", "name": "id", - "description": "Id of the classification policy", + "description": "Id of the classification policy.", "required": true, "type": "string" }, @@ -126,14 +132,14 @@ } ], "responses": { + "204": { + "description": "Success" + }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/CommunicationErrorResponse" } - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -148,7 +154,7 @@ "tags": [ "ClassificationPolicies" ], - "summary": "Retrieves existing classification policies", + "summary": "Retrieves existing classification policies.", "operationId": "JobRouterAdministration_ListClassificationPolicies", "produces": [ "application/json" @@ -157,27 +163,26 @@ { "in": "query", "name": "maxpagesize", - "description": "Maximum page size", + "description": "Maximum page size.", "type": "integer", - "format": "int32", - "default": 20 + "format": "int32" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/ClassificationPolicyCollection" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -208,7 +213,7 @@ { "in": "path", "name": "id", - "description": "Id of the distribution policy", + "description": "Id of the distribution policy.", "required": true, "type": "string" }, @@ -218,7 +223,7 @@ { "in": "body", "name": "patch", - "description": "Model of distribution policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of distribution policy properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/DistributionPolicy" @@ -226,17 +231,23 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/DistributionPolicy" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/DistributionPolicy" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -252,7 +263,7 @@ "tags": [ "DistributionPolicies" ], - "summary": "Retrieves an existing distribution policy by Id", + "summary": "Retrieves an existing distribution policy by Id.", "operationId": "JobRouterAdministration_GetDistributionPolicy", "produces": [ "application/json" @@ -261,7 +272,7 @@ { "in": "path", "name": "id", - "description": "Id of the distribution policy", + "description": "Id of the distribution policy.", "required": true, "type": "string" }, @@ -270,17 +281,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/DistributionPolicy" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -293,7 +304,7 @@ "tags": [ "DistributionPolicies" ], - "summary": "Delete a distribution policy by Id", + "summary": "Delete a distribution policy by Id.", "operationId": "JobRouterAdministration_DeleteDistributionPolicy", "produces": [ "application/json" @@ -302,7 +313,7 @@ { "in": "path", "name": "id", - "description": "Id of the distribution policy", + "description": "Id of the distribution policy.", "required": true, "type": "string" }, @@ -311,14 +322,14 @@ } ], "responses": { + "204": { + "description": "Success" + }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/CommunicationErrorResponse" } - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -333,7 +344,7 @@ "tags": [ "DistributionPolicies" ], - "summary": "Retrieves existing distribution policies", + "summary": "Retrieves existing distribution policies.", "operationId": "JobRouterAdministration_ListDistributionPolicies", "produces": [ "application/json" @@ -342,27 +353,26 @@ { "in": "query", "name": "maxpagesize", - "description": "Maximum page size", + "description": "Maximum page size.", "type": "integer", - "format": "int32", - "default": 20 + "format": "int32" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/DistributionPolicyCollection" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -393,7 +403,7 @@ { "in": "path", "name": "id", - "description": "Id of the exception policy", + "description": "Id of the exception policy.", "required": true, "type": "string" }, @@ -411,17 +421,23 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/ExceptionPolicy" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/ExceptionPolicy" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -437,7 +453,7 @@ "tags": [ "ExceptionPolicies" ], - "summary": "Retrieves an existing exception policy by Id", + "summary": "Retrieves an existing exception policy by Id.", "operationId": "JobRouterAdministration_GetExceptionPolicy", "produces": [ "application/json" @@ -446,7 +462,7 @@ { "in": "path", "name": "id", - "description": "Id of the exception policy to retrieve", + "description": "Id of the exception policy to retrieve.", "required": true, "type": "string" }, @@ -455,17 +471,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/ExceptionPolicy" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -478,7 +494,7 @@ "tags": [ "ExceptionPolicies" ], - "summary": "Deletes a exception policy by Id", + "summary": "Deletes a exception policy by Id.", "operationId": "JobRouterAdministration_DeleteExceptionPolicy", "produces": [ "application/json" @@ -487,7 +503,7 @@ { "in": "path", "name": "id", - "description": "Id of the exception policy to delete", + "description": "Id of the exception policy to delete.", "required": true, "type": "string" }, @@ -496,14 +512,14 @@ } ], "responses": { + "204": { + "description": "Success" + }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/CommunicationErrorResponse" } - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -518,7 +534,7 @@ "tags": [ "ExceptionPolicies" ], - "summary": "Retrieves existing exception policies", + "summary": "Retrieves existing exception policies.", "operationId": "JobRouterAdministration_ListExceptionPolicies", "produces": [ "application/json" @@ -527,27 +543,26 @@ { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", - "format": "int32", - "default": 20 + "format": "int32" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/ExceptionPolicyCollection" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -596,17 +611,23 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterJob" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/RouterJob" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -615,6 +636,9 @@ }, "Update a job": { "$ref": "./examples/Jobs_UpdateJob.json" + }, + "Creates a scheduled job": { + "$ref": "./examples/Jobs_CreateScheduledJob.json" } } }, @@ -622,7 +646,7 @@ "tags": [ "Jobs" ], - "summary": "Retrieves an existing job by Id", + "summary": "Retrieves an existing job by Id.", "operationId": "JobRouter_GetJob", "produces": [ "application/json" @@ -631,7 +655,7 @@ { "in": "path", "name": "id", - "description": "Id of the job to retrieve", + "description": "Id of the job to retrieve.", "required": true, "type": "string" }, @@ -640,17 +664,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/RouterJob" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -681,14 +705,14 @@ } ], "responses": { + "204": { + "description": "Success" + }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/CommunicationErrorResponse" } - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -706,9 +730,7 @@ "summary": "Reclassify a job.", "operationId": "JobRouter_ReclassifyJobAction", "consumes": [ - "application/json", - "text/json", - "application/*+json" + "application/json" ], "produces": [ "application/json" @@ -717,7 +739,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -734,17 +756,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/ReclassifyJobResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -771,7 +793,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -781,7 +803,7 @@ { "in": "body", "name": "cancelJobRequest", - "description": "Request model for cancelling job", + "description": "Request model for cancelling job.", "schema": { "$ref": "#/definitions/CancelJobRequest" }, @@ -789,17 +811,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/CancelJobResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -826,7 +848,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -836,7 +858,7 @@ { "in": "body", "name": "completeJobRequest", - "description": "Request model for completing job", + "description": "Request model for completing job.", "required": true, "schema": { "$ref": "#/definitions/CompleteJobRequest" @@ -845,17 +867,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/CompleteJobResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -882,7 +904,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -892,7 +914,7 @@ { "in": "body", "name": "closeJobRequest", - "description": "Request model for closing job", + "description": "Request model for closing job.", "required": true, "schema": { "$ref": "#/definitions/CloseJobRequest" @@ -901,12 +923,6 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { @@ -918,6 +934,12 @@ "schema": { "$ref": "#/definitions/CloseJobResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -932,7 +954,7 @@ "tags": [ "Jobs" ], - "summary": "Retrieves list of jobs based on filter parameters", + "summary": "Retrieves list of jobs based on filter parameters.", "operationId": "JobRouter_ListJobs", "produces": [ "application/json" @@ -941,7 +963,7 @@ { "in": "query", "name": "status", - "description": "(Optional) If specified, filter jobs by status.", + "description": "If specified, filter jobs by status.", "type": "string", "default": "all", "enum": [ @@ -953,54 +975,72 @@ "closed", "cancelled", "classificationFailed", + "created", + "pendingSchedule", + "scheduled", + "scheduleFailed", + "waitingForActivation", "active" ], "x-ms-enum": { - "name": "JobStateSelector", - "modelAsString": false + "name": "RouterJobStatusSelector", + "modelAsString": true } }, { "in": "query", "name": "queueId", - "description": "(Optional) If specified, filter jobs by queue.", + "description": "If specified, filter jobs by queue.", "type": "string" }, { "in": "query", "name": "channelId", - "description": "(Optional) If specified, filter jobs by channel.", + "description": "If specified, filter jobs by channel.", "type": "string" }, { "in": "query", "name": "classificationPolicyId", - "description": "(Optional) If specified, filter jobs by classificationPolicy.", + "description": "If specified, filter jobs by classificationPolicy.", "type": "string" }, + { + "in": "query", + "name": "scheduledBefore", + "description": "If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore].", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "scheduledAfter", + "description": "If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf).", + "type": "string", + "format": "date-time" + }, { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", - "format": "int32", - "default": 20 + "format": "int32" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterJobCollection" } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/JobCollection" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1029,7 +1069,7 @@ { "in": "path", "name": "id", - "description": "Id of the job", + "description": "Id of the job.", "required": true, "type": "string" }, @@ -1038,16 +1078,16 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterJobPositionDetails" } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/JobPositionDetails" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1065,6 +1105,9 @@ ], "summary": "Un-assign a job.", "operationId": "JobRouter_UnassignJobAction", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -1072,33 +1115,41 @@ { "in": "path", "name": "id", - "description": "Id of the job to un-assign", + "description": "Id of the job to un-assign.", "required": true, "type": "string" }, { "in": "path", "name": "assignmentId", - "description": "Id of the assignment to un-assign", + "description": "Id of the assignment to un-assign.", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "unassignJobRequest", + "description": "Request body for unassign route.", + "schema": { + "$ref": "#/definitions/UnassignJobRequest" + } } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/UnassignJobResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -1122,14 +1173,14 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker", + "description": "Id of the worker.", "required": true, "type": "string" }, { "in": "path", "name": "offerId", - "description": "Id of the offer", + "description": "Id of the offer.", "required": true, "type": "string" }, @@ -1138,17 +1189,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/AcceptJobOfferResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -1165,6 +1216,9 @@ ], "summary": "Declines an offer to work on a job.", "operationId": "JobRouter_DeclineJobAction", + "consumes": [ + "application/json" + ], "produces": [ "application/json" ], @@ -1172,33 +1226,41 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker", + "description": "Id of the worker.", "required": true, "type": "string" }, { "in": "path", "name": "offerId", - "description": "Id of the offer", + "description": "Id of the offer.", "required": true, "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "declineJobOfferRequest", + "description": "Request model for declining offer.", + "schema": { + "$ref": "#/definitions/DeclineJobOfferRequest" + } } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/DeclineJobOfferResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -1225,7 +1287,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue", + "description": "Id of the queue.", "required": true, "type": "string" }, @@ -1235,24 +1297,30 @@ { "in": "body", "name": "patch", - "description": "Model of queue properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of queue properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { - "$ref": "#/definitions/JobQueue" + "$ref": "#/definitions/RouterQueue" } } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterQueue" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RouterQueue" + } + }, + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/JobQueue" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1269,7 +1337,7 @@ "tags": [ "Queues" ], - "summary": "Retrieves an existing queue by Id", + "summary": "Retrieves an existing queue by Id.", "operationId": "JobRouterAdministration_GetQueue", "produces": [ "application/json" @@ -1278,7 +1346,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue to retrieve", + "description": "Id of the queue to retrieve.", "required": true, "type": "string" }, @@ -1287,16 +1355,16 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterQueue" } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/JobQueue" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1310,7 +1378,7 @@ "tags": [ "Queues" ], - "summary": "Deletes a queue by Id", + "summary": "Deletes a queue by Id.", "operationId": "JobRouterAdministration_DeleteQueue", "produces": [ "application/json" @@ -1319,7 +1387,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue to delete", + "description": "Id of the queue to delete.", "required": true, "type": "string" }, @@ -1328,14 +1396,14 @@ } ], "responses": { + "204": { + "description": "Success" + }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/CommunicationErrorResponse" } - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -1350,7 +1418,7 @@ "tags": [ "Queues" ], - "summary": "Retrieves existing queues", + "summary": "Retrieves existing queues.", "operationId": "JobRouterAdministration_ListQueues", "produces": [ "application/json" @@ -1359,26 +1427,25 @@ { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", - "format": "int32", - "default": 20 + "format": "int32" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterQueueCollection" } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/QueueCollection" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1398,7 +1465,7 @@ "tags": [ "Queues" ], - "summary": "Retrieves a queue's statistics", + "summary": "Retrieves a queue's statistics.", "operationId": "JobRouter_GetQueueStatistics", "produces": [ "application/json" @@ -1407,7 +1474,7 @@ { "in": "path", "name": "id", - "description": "Id of the queue to retrieve statistics", + "description": "Id of the queue to retrieve statistics.", "required": true, "type": "string" }, @@ -1416,16 +1483,16 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterQueueStatistics" } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/QueueStatistics" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1453,7 +1520,7 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker", + "description": "Id of the worker.", "required": true, "type": "string" }, @@ -1463,7 +1530,7 @@ { "in": "body", "name": "patch", - "description": "Model of worker properties to be patched. See also: https://datatracker.ietf.org/doc/html/rfc7386", + "description": "Model of worker properties to be created or patched. See also: https://datatracker.ietf.org/doc/html/rfc7386.", "required": true, "schema": { "$ref": "#/definitions/RouterWorker" @@ -1471,17 +1538,23 @@ } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterWorker" } }, - "200": { - "description": "Success", + "201": { + "description": "Created", "schema": { "$ref": "#/definitions/RouterWorker" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -1506,7 +1579,7 @@ "tags": [ "Workers" ], - "summary": "Retrieves an existing worker by Id", + "summary": "Retrieves an existing worker by Id.", "operationId": "JobRouter_GetWorker", "produces": [ "application/json" @@ -1515,7 +1588,7 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker to retrieve", + "description": "Id of the worker to retrieve.", "required": true, "type": "string" }, @@ -1524,17 +1597,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/RouterWorker" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } } }, "x-ms-examples": { @@ -1556,7 +1629,7 @@ { "in": "path", "name": "workerId", - "description": "Id of the worker to delete", + "description": "Id of the worker to delete.", "required": true, "type": "string" }, @@ -1565,14 +1638,14 @@ } ], "responses": { + "204": { + "description": "Success" + }, "default": { "description": "Error", "schema": { "$ref": "#/definitions/CommunicationErrorResponse" } - }, - "204": { - "description": "Success" } }, "x-ms-examples": { @@ -1595,8 +1668,8 @@ "parameters": [ { "in": "query", - "name": "status", - "description": "(Optional) If specified, select workers by worker status.", + "name": "state", + "description": "If specified, select workers by worker state.", "type": "string", "default": "all", "enum": [ @@ -1606,51 +1679,50 @@ "all" ], "x-ms-enum": { - "name": "WorkerStateSelector", - "modelAsString": false + "name": "RouterWorkerStateSelector", + "modelAsString": true } }, { "in": "query", "name": "channelId", - "description": "(Optional) If specified, select workers who have a channel configuration with this channel", + "description": "If specified, select workers who have a channel configuration with this channel.", "type": "string" }, { "in": "query", "name": "queueId", - "description": "(Optional) If specified, select workers who are assigned to this queue", + "description": "If specified, select workers who are assigned to this queue.", "type": "string" }, { "in": "query", "name": "hasCapacity", - "description": "(Optional) If set to true, select only workers who have capacity for the channel specified by `channelId` or for any channel\r\n if `channelId` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false.", + "description": "If set to true, select only workers who have capacity for the channel specified by `channelId` or for any channel if `channelId` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false.", "type": "boolean" }, { "in": "query", "name": "maxpagesize", - "description": "Number of objects to return per page", + "description": "Number of objects to return per page.", "type": "integer", - "format": "int32", - "default": 20 + "format": "int32" }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { - "default": { - "description": "Error", + "200": { + "description": "Success", "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" + "$ref": "#/definitions/RouterWorkerCollection" } }, - "200": { - "description": "Success", + "default": { + "description": "Error", "schema": { - "$ref": "#/definitions/WorkerCollection" + "$ref": "#/definitions/CommunicationErrorResponse" } } }, @@ -1681,14 +1753,17 @@ "properties": { "assignmentId": { "description": "The assignment Id that assigns a worker that has accepted an offer to a job.", + "minLength": 1, "type": "string" }, "jobId": { "description": "The Id of the job assigned.", + "minLength": 1, "type": "string" }, "workerId": { "description": "The Id of the worker that has been assigned this job.", + "minLength": 1, "type": "string" } } @@ -1703,6 +1778,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing BestWorkerMode", "type": "string" }, "scoringRule": { @@ -1724,11 +1800,11 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing CancelExceptionAction", + "type": "string" }, "note": { - "description": "(Optional) A note that will be appended to the jobs' Notes collection with th current timestamp.", + "description": "(Optional) A note that will be appended to the jobs' Notes collection with the current timestamp.", "maxLength": 2000, "minLength": 0, "type": "string" @@ -1747,7 +1823,7 @@ "type": "object", "properties": { "note": { - "description": "(Optional) A note that will be appended to the jobs' Notes collection with th current timestamp.", + "description": "(Optional) A note that will be appended to the jobs' Notes collection with the current timestamp.", "maxLength": 2000, "minLength": 0, "type": "string" @@ -1776,6 +1852,11 @@ "format": "int32", "description": "The amount of capacity that an instance of a job of this channel will consume of the total worker capacity.", "type": "integer" + }, + "maxNumberOfJobs": { + "format": "int32", + "description": "The maximum number of jobs that can be supported concurrently for this channel.", + "type": "integer" } } }, @@ -1800,7 +1881,7 @@ "description": "The queue selectors to resolve a queue for a given job.", "type": "array", "items": { - "description": "An attachment of label selectors to resolve a queue to a job from a classification policy" + "description": "An attachment of queue selectors to resolve a queue to a job from a classification policy" } }, "prioritizationRule": { @@ -1810,7 +1891,7 @@ "description": "The worker label selectors to attach to a given job.", "type": "array", "items": { - "description": "An attachment which attaches WorkerSelectors to workers" + "description": "An attachment which attaches worker selectors to a job" } } } @@ -1866,13 +1947,13 @@ "minLength": 0, "type": "string" }, - "closeTime": { + "closeAt": { "format": "date-time", - "description": "If not provided, worker capacity is released immediately along with a JobClosedEvent notification.\r\nIf provided, worker capacity is released along with a JobClosedEvent notification at a future time.", + "description": "If not provided, worker capacity is released immediately along with a JobClosedEvent notification.\r\nIf provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC.", "type": "string" }, "note": { - "description": "(Optional) A note that will be appended to the jobs' Notes collection with th current timestamp.", + "description": "(Optional) A note that will be appended to the jobs' Notes collection with the current timestamp.", "maxLength": 2000, "minLength": 0, "type": "string" @@ -1885,54 +1966,10 @@ "properties": {} }, "CommunicationError": { - "description": "The Communication Services error.", - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - }, - "target": { - "type": "string", - "readOnly": true, - "description": "The error target." - }, - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationError" - }, - "readOnly": true, - "description": "Further details about specific errors that led to this error." - }, - "innererror": { - "x-ms-client-name": "innerError", - "readOnly": true, - "$ref": "#/definitions/CommunicationError", - "description": "The inner error if any." - } - } + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationError" }, "CommunicationErrorResponse": { - "description": "The Communication Services error.", - "type": "object", - "required": [ - "error" - ], - "properties": { - "error": { - "description": "The Communication Services error.", - "$ref": "#/definitions/CommunicationError" - } - } + "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" }, "CompleteJobRequest": { "description": "Request payload for completing jobs", @@ -1948,7 +1985,7 @@ "type": "string" }, "note": { - "description": "(Optional) A note that will be appended to the jobs' Notes collection with th current timestamp.", + "description": "(Optional) A note that will be appended to the jobs' Notes collection with the current timestamp.", "maxLength": 2000, "minLength": 0, "type": "string" @@ -1961,10 +1998,10 @@ "properties": {} }, "ConditionalQueueSelectorAttachment": { - "description": "Describes a set of label selectors that will be attached if the given condition resolves to true", + "description": "Describes a set of queue selectors that will be attached if the given condition resolves to true", "required": [ "condition", - "labelSelectors" + "queueSelectors" ], "type": "object", "allOf": [ @@ -1974,27 +2011,27 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing ConditionalQueueSelectorAttachment", + "type": "string" }, "condition": { "$ref": "#/definitions/RouterRule" }, - "labelSelectors": { - "description": "The label selectors to attach", + "queueSelectors": { + "description": "The queue selectors to attach", "type": "array", "items": { - "$ref": "#/definitions/QueueSelector" + "$ref": "#/definitions/RouterQueueSelector" } } }, "x-ms-discriminator-value": "conditional" }, "ConditionalWorkerSelectorAttachment": { - "description": "Describes a set of label selectors that will be attached if the given condition resolves to true", + "description": "Describes a set of worker selectors that will be attached if the given condition resolves to true", "required": [ "condition", - "labelSelectors" + "workerSelectors" ], "type": "object", "allOf": [ @@ -2004,28 +2041,39 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing ConditionalWorkerSelectorAttachment", + "type": "string" }, "condition": { "$ref": "#/definitions/RouterRule" }, - "labelSelectors": { - "description": "The label selectors to attach", + "workerSelectors": { + "description": "The worker selectors to attach", "type": "array", "items": { - "$ref": "#/definitions/WorkerSelector" + "$ref": "#/definitions/RouterWorkerSelector" } } }, "x-ms-discriminator-value": "conditional" }, + "DeclineJobOfferRequest": { + "description": "Request payload for declining offers", + "type": "object", + "properties": { + "retryOfferAt": { + "format": "date-time", + "description": "If the RetryOfferAt is not provided, then this job will not be offered again to the worker who declined this job unless\r\nthe worker is de-registered and re-registered. If a RetryOfferAt time is provided, then the job will be re-matched to\r\neligible workers at the retry time in UTC. The worker that declined the job will also be eligible for the job at that time.", + "type": "string" + } + } + }, "DeclineJobOfferResult": { "description": "Response payload from declining a job", "type": "object", "properties": {} }, - "DirectMapRule": { + "DirectMapRouterRule": { "description": "A rule that return the same labels as the input labels.", "type": "object", "allOf": [ @@ -2035,6 +2083,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing DirectMapRouterRule", "type": "string" } }, @@ -2043,9 +2092,7 @@ "DistributionMode": { "description": "Abstract base class for defining a distribution mode", "required": [ - "kind", - "maxConcurrentOffers", - "minConcurrentOffers" + "kind" ], "type": "object", "properties": { @@ -2083,9 +2130,9 @@ "description": "The human readable name of the policy.", "type": "string" }, - "offerTtlSeconds": { + "offerExpiresAfterSeconds": { "format": "double", - "description": "The expiry time of any offers created under this policy will be governed by the offer time to live.", + "description": "The number of seconds after which any offers created under this policy will be expired.", "type": "number" }, "mode": { @@ -2202,7 +2249,7 @@ "type": "object", "properties": { "trigger": { - "$ref": "#/definitions/JobExceptionTrigger" + "$ref": "#/definitions/ExceptionTrigger" }, "actions": { "description": "A dictionary collection of actions to perform once the exception is triggered. Key is the Id of each exception action.", @@ -2213,11 +2260,24 @@ } } }, - "ExpressionRule": { + "ExceptionTrigger": { + "description": "The trigger for this exception rule", + "required": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "description": "The type discriminator describing a sub-type of ExceptionTrigger", + "type": "string" + } + }, + "discriminator": "kind" + }, + "ExpressionRouterRule": { "description": "A rule providing inline expression rules.", "required": [ - "expression", - "language" + "expression" ], "type": "object", "allOf": [ @@ -2227,6 +2287,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing ExpressionRouterRule", "type": "string" }, "language": { @@ -2236,8 +2297,8 @@ ], "type": "string", "x-ms-enum": { - "name": "ExpressionLanguage", - "modelAsString": false + "name": "ExpressionRouterRuleLanguage", + "modelAsString": true } }, "expression": { @@ -2249,7 +2310,7 @@ }, "x-ms-discriminator-value": "expression-rule" }, - "FunctionRule": { + "FunctionRouterRule": { "description": "A rule providing a binding to an HTTP Triggered Azure Function.", "required": [ "functionUri" @@ -2262,6 +2323,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing FunctionRouterRule", "type": "string" }, "functionUri": { @@ -2270,12 +2332,12 @@ "type": "string" }, "credential": { - "$ref": "#/definitions/FunctionRuleCredential" + "$ref": "#/definitions/FunctionRouterRuleCredential" } }, "x-ms-discriminator-value": "azure-function-rule" }, - "FunctionRuleCredential": { + "FunctionRouterRuleCredential": { "description": "Credentials used to access Azure function rule", "type": "object", "properties": { @@ -2299,210 +2361,62 @@ } } }, - "JobAssignment": { - "description": "Assignment details of a job to a worker", - "required": [ - "assignTime", - "id" - ], + "JobMatchingMode": { + "description": "The matching mode to be applied to this job.\r\n \r\nSupported types:\r\n \r\nQueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued.\r\nScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically.\r\nSuspendMode: Used when matching workers to a job needs to be suspended.", "type": "object", "properties": { - "id": { - "description": "The Id of the job assignment.", - "type": "string" - }, - "workerId": { - "description": "The Id of the Worker assigned to the job.", - "type": "string" + "modeType": { + "description": "Discriminator value used to differentiate between supported matching mode types.", + "enum": [ + "queueAndMatchMode", + "scheduleAndSuspendMode", + "suspendMode" + ], + "type": "string", + "x-ms-enum": { + "name": "JobMatchModeType", + "modelAsString": true + } }, - "assignTime": { - "format": "date-time", - "description": "The assignment time of the job.", - "type": "string" + "queueAndMatchMode": { + "$ref": "#/definitions/QueueAndMatchMode" }, - "completeTime": { - "format": "date-time", - "description": "The time the job was marked as completed after being assigned.", - "type": "string" + "scheduleAndSuspendMode": { + "$ref": "#/definitions/ScheduleAndSuspendMode" }, - "closeTime": { - "format": "date-time", - "description": "The time the job was marked as closed after being completed.", - "type": "string" + "suspendMode": { + "$ref": "#/definitions/SuspendMode" } } }, - "JobCollection": { - "description": "A paged collection of jobs.", - "required": [ - "value" - ], + "LongestIdleMode": { + "description": "Jobs are directed to the worker who has been idle longest.", "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RouterJobItem" - } - }, - "nextLink": { - "type": "string", - "readOnly": true + "allOf": [ + { + "$ref": "#/definitions/DistributionMode" } - } - }, - "JobExceptionTrigger": { - "description": "The trigger for this exception rule", - "required": [ - "kind" ], - "type": "object", "properties": { "kind": { - "description": "The type discriminator describing a sub-type of ExceptionTrigger", + "description": "The type discriminator describing LongestIdleMode", "type": "string" } }, - "discriminator": "kind" + "x-ms-discriminator-value": "longest-idle" }, - "JobOffer": { - "description": "An offer of a job to a worker", - "required": [ - "capacityCost", - "id", - "jobId" - ], + "ManualReclassifyExceptionAction": { + "description": "An action that manually reclassifies a job by providing the queue, priority and worker selectors.", "type": "object", - "properties": { - "id": { - "description": "The Id of the offer.", - "type": "string" - }, - "jobId": { - "description": "The Id of the job.", - "type": "string" - }, - "capacityCost": { - "format": "int32", - "description": "The capacity cost consumed by the job offer.", - "type": "integer" - }, - "offerTimeUtc": { - "format": "date-time", - "description": "The time the offer was created.", - "type": "string" - }, - "expiryTimeUtc": { - "format": "date-time", - "description": "The time that the offer will expire.", - "type": "string" - } - } - }, - "JobPositionDetails": { - "description": "Dto for JobPositionDetails.", - "required": [ - "estimatedWaitTimeMinutes", - "jobId", - "position", - "queueId", - "queueLength" - ], - "type": "object", - "properties": { - "jobId": { - "description": "Id of the job these details are about.", - "type": "string" - }, - "position": { - "format": "int32", - "description": "Position of the job in question within that queue.", - "type": "integer" - }, - "queueId": { - "description": "Id of the queue this job is enqueued in.", - "type": "string" - }, - "queueLength": { - "format": "int32", - "description": "Length of the queue: total number of enqueued jobs.", - "type": "integer" - }, - "estimatedWaitTimeMinutes": { - "format": "double", - "description": "Estimated wait time of the job rounded up to the nearest minute", - "type": "number" - } - } - }, - "JobQueue": { - "description": "A queue that can contain jobs to be routed.", - "type": "object", - "properties": { - "id": { - "description": "The Id of this queue", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of this queue.", - "type": "string" - }, - "distributionPolicyId": { - "description": "The ID of the distribution policy that will determine how a job is distributed to workers.", - "type": "string" - }, - "labels": { - "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", - "type": "object", - "additionalProperties": {} - }, - "exceptionPolicyId": { - "description": "(Optional) The ID of the exception policy that determines various job escalation rules.", - "type": "string" - } - } - }, - "JobQueueItem": { - "description": "Paged instance of JobQueue", - "type": "object", - "properties": { - "jobQueue": { - "$ref": "#/definitions/JobQueue" - }, - "etag": { - "description": "(Optional) The Concurrency Token.", - "type": "string" - } - } - }, - "LongestIdleMode": { - "description": "Jobs are directed to the worker who has been idle longest.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DistributionMode" - } - ], + "allOf": [ + { + "$ref": "#/definitions/ExceptionAction" + } + ], "properties": { "kind": { + "description": "The type discriminator describing ManualReclassifyExceptionAction", "type": "string" - } - }, - "x-ms-discriminator-value": "longest-idle" - }, - "ManualReclassifyExceptionAction": { - "description": "An action that manually reclassifies a job by providing the queue, priority and worker selectors.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExceptionAction" - } - ], - "properties": { - "kind": { - "type": "string", - "readOnly": true }, "queueId": { "description": "Updated QueueId.", @@ -2519,14 +2433,32 @@ "description": "Updated WorkerSelectors.", "type": "array", "items": { - "$ref": "#/definitions/WorkerSelector" + "$ref": "#/definitions/RouterWorkerSelector" } } }, "x-ms-discriminator-value": "manual-reclassify" }, + "Oauth2ClientCredential": { + "description": "OAuth2.0 Credentials used to Contoso's Authorization server.\r\nReference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/", + "type": "object", + "properties": { + "clientId": { + "description": "ClientId for Contoso Authorization server.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "clientSecret": { + "description": "Client secret for Contoso Authorization server.", + "maxLength": 500, + "minLength": 0, + "type": "string" + } + } + }, "PassThroughQueueSelectorAttachment": { - "description": "Attaches a label selector where the value is pass through from the job label with the same key", + "description": "Attaches a queue selector where the value is passed through from the job label with the same key", "required": [ "key", "labelOperator" @@ -2539,8 +2471,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing PassThroughQueueSelectorAttachment", + "type": "string" }, "key": { "description": "The label key to query against", @@ -2561,14 +2493,14 @@ "type": "string", "x-ms-enum": { "name": "LabelOperator", - "modelAsString": false + "modelAsString": true } } }, "x-ms-discriminator-value": "pass-through" }, "PassThroughWorkerSelectorAttachment": { - "description": "Attaches a label selector where the value is pass through from the job label with the same key", + "description": "Attaches a worker selector where the value is passed through from the job label with the same key", "required": [ "key", "labelOperator" @@ -2581,8 +2513,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing PassThroughWorkerSelectorAttachment", + "type": "string" }, "key": { "description": "The label key to query against", @@ -2603,10 +2535,10 @@ "type": "string", "x-ms-enum": { "name": "LabelOperator", - "modelAsString": false + "modelAsString": true } }, - "ttlSeconds": { + "expiresAfterSeconds": { "format": "double", "description": "Describes how long the attached label selector is valid in seconds.", "type": "number" @@ -2614,29 +2546,9 @@ }, "x-ms-discriminator-value": "pass-through" }, - "QueueAssignment": { - "description": "An assignment of a worker to a queue", - "type": "object", - "properties": {} - }, - "QueueCollection": { - "description": "A paged collection of queues.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobQueueItem" - } - }, - "nextLink": { - "type": "string", - "readOnly": true - } - } + "QueueAndMatchMode": { + "description": "Describes a matching mode where matching worker to a job is automatically started after job is queued successfully.", + "type": "object" }, "QueueLengthExceptionTrigger": { "description": "Trigger for an exception action on exceeding queue length", @@ -2646,11 +2558,12 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/JobExceptionTrigger" + "$ref": "#/definitions/ExceptionTrigger" } ], "properties": { "kind": { + "description": "The type discriminator describing a sub-type of QueueLengthExceptionTrigger", "type": "string" }, "threshold": { @@ -2661,92 +2574,24 @@ }, "x-ms-discriminator-value": "queue-length" }, - "QueueSelector": { - "description": "Describes a condition that must be met against a set of labels for queue selection", - "required": [ - "key", - "labelOperator" - ], - "type": "object", - "properties": { - "key": { - "description": "The label key to query against", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "labelOperator": { - "description": "Describes how the value of the label is compared to the value defined on the label selector", - "enum": [ - "equal", - "notEqual", - "lessThan", - "lessThanEqual", - "greaterThan", - "greaterThanEqual" - ], - "type": "string", - "x-ms-enum": { - "name": "LabelOperator", - "modelAsString": false - } - }, - "value": { - "description": "The value to compare against the actual label value with the given operator", - "type": "object" - } - } - }, "QueueSelectorAttachment": { - "description": "An attachment of label selectors to resolve a queue to a job from a classification policy", + "description": "An attachment of queue selectors to resolve a queue to a job from a classification policy", "required": [ "kind" ], "type": "object", "properties": { "kind": { - "description": "The type discriminator describing the type of label selector attachment", + "description": "The type discriminator describing the type of queue selector attachment", "type": "string" } }, "discriminator": "kind" }, - "QueueStatistics": { - "description": "Statistics for the queue", - "required": [ - "length", - "queueId" - ], - "type": "object", - "properties": { - "queueId": { - "description": "Id of the queue these details are about.", - "type": "string" - }, - "length": { - "format": "int32", - "description": "Length of the queue: total number of enqueued jobs.", - "type": "integer" - }, - "estimatedWaitTimeMinutes": { - "description": "The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority", - "type": "object", - "additionalProperties": { - "format": "double", - "type": "number" - } - }, - "longestJobWaitTimeMinutes": { - "format": "double", - "description": "The wait time of the job that has been enqueued in this queue for the longest.", - "type": "number" - } - } - }, "QueueWeightedAllocation": { - "description": "Contains the weight percentage and label selectors to be applied if selected for weighted distributions.", + "description": "Contains the weight percentage and queue selectors to be applied if selected for weighted distributions.", "required": [ - "labelSelectors", + "queueSelectors", "weight" ], "type": "object", @@ -2756,11 +2601,11 @@ "description": "The percentage of this weight, expressed as a fraction of 1.", "type": "number" }, - "labelSelectors": { - "description": "A collection of label selectors that will be applied if this allocation is selected.", + "queueSelectors": { + "description": "A collection of queue selectors that will be applied if this allocation is selected.", "type": "array", "items": { - "$ref": "#/definitions/QueueSelector" + "$ref": "#/definitions/RouterQueueSelector" } } } @@ -2775,8 +2620,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing ReclassifyExceptionAction.", + "type": "string" }, "classificationPolicyId": { "description": "(optional) The new classification policy that will determine queue, priority and worker selectors.", @@ -2794,8 +2639,7 @@ }, "ReclassifyJobRequest": { "description": "Request payload for reclassifying jobs", - "type": "object", - "properties": {} + "type": "object" }, "ReclassifyJobResult": { "description": "Response payload from reclassifying a job", @@ -2812,6 +2656,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing RoundRobinMode", "type": "string" } }, @@ -2830,8 +2675,8 @@ "description": "Reference to an external parent context, eg. call ID.", "type": "string" }, - "jobStatus": { - "description": "The state of the Job.", + "status": { + "description": "The status of the Job.", "enum": [ "pendingClassification", "queued", @@ -2840,18 +2685,22 @@ "closed", "cancelled", "classificationFailed", - "created" + "created", + "pendingSchedule", + "scheduled", + "scheduleFailed", + "waitingForActivation" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "RouterJobStatus", - "modelAsString": false + "modelAsString": true } }, - "enqueueTimeUtc": { + "enqueuedAt": { "format": "date-time", - "description": "The time a job was queued.", + "description": "The time a job was queued in UTC.", "type": "string", "readOnly": true }, @@ -2880,14 +2729,14 @@ "description": "A collection of manually specified label selectors, which a worker must satisfy in order to process this job.", "type": "array", "items": { - "$ref": "#/definitions/WorkerSelector" + "$ref": "#/definitions/RouterWorkerSelector" } }, "attachedWorkerSelectors": { "description": "A collection of label selectors attached by a classification policy, which a worker must satisfy in order to process this job.", "type": "array", "items": { - "$ref": "#/definitions/WorkerSelector" + "$ref": "#/definitions/RouterWorkerSelector" }, "readOnly": true }, @@ -2900,7 +2749,7 @@ "description": "A collection of the assignments of the job.\r\nKey is AssignmentId.", "type": "object", "additionalProperties": { - "$ref": "#/definitions/JobAssignment" + "$ref": "#/definitions/RouterJobAssignment" }, "readOnly": true }, @@ -2915,24 +2764,293 @@ "additionalProperties": { "type": "string" } + }, + "scheduledAt": { + "format": "date-time", + "description": "If set, job will be scheduled to be enqueued at a given time", + "type": "string", + "readOnly": true + }, + "matchingMode": { + "$ref": "#/definitions/JobMatchingMode" } } }, - "RouterJobItem": { - "description": "Paged instance of RouterJob", + "RouterJobAssignment": { + "description": "Assignment details of a job to a worker", + "required": [ + "assignedAt", + "assignmentId" + ], "type": "object", "properties": { - "routerJob": { - "$ref": "#/definitions/RouterJob" + "assignmentId": { + "description": "The Id of the job assignment.", + "minLength": 1, + "type": "string" }, - "etag": { - "description": "(Optional) The Concurrency Token.", + "workerId": { + "description": "The Id of the Worker assigned to the job.", + "type": "string" + }, + "assignedAt": { + "format": "date-time", + "description": "The assignment time of the job in UTC.", + "type": "string" + }, + "completedAt": { + "format": "date-time", + "description": "The time the job was marked as completed after being assigned in UTC.", + "type": "string" + }, + "closedAt": { + "format": "date-time", + "description": "The time the job was marked as closed after being completed in UTC.", "type": "string" } } }, - "RouterRule": { - "description": "A rule of one of the following types:\r\n \r\nStaticRule: A rule providing static rules that always return the same result, regardless of input.\r\nDirectMapRule: A rule that return the same labels as the input labels.\r\nExpressionRule: A rule providing inline expression rules.\r\nAzureFunctionRule: A rule providing a binding to an HTTP Triggered Azure Function.", + "RouterJobCollection": { + "description": "A paged collection of jobs.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouterJobItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "RouterJobItem": { + "description": "Paged instance of RouterJob", + "type": "object", + "properties": { + "job": { + "$ref": "#/definitions/RouterJob" + }, + "etag": { + "description": "(Optional) The Concurrency Token.", + "type": "string" + } + } + }, + "RouterJobOffer": { + "description": "An offer of a job to a worker", + "required": [ + "capacityCost", + "jobId", + "offerId" + ], + "type": "object", + "properties": { + "offerId": { + "description": "The Id of the offer.", + "minLength": 1, + "type": "string" + }, + "jobId": { + "description": "The Id of the job.", + "minLength": 1, + "type": "string" + }, + "capacityCost": { + "format": "int32", + "description": "The capacity cost consumed by the job offer.", + "type": "integer" + }, + "offeredAt": { + "format": "date-time", + "description": "The time the offer was created in UTC.", + "type": "string" + }, + "expiresAt": { + "format": "date-time", + "description": "The time that the offer will expire in UTC.", + "type": "string" + } + } + }, + "RouterJobPositionDetails": { + "description": "Position and estimated wait time for a job.", + "required": [ + "estimatedWaitTimeMinutes", + "jobId", + "position", + "queueId", + "queueLength" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Id of the job these details are about.", + "minLength": 1, + "type": "string" + }, + "position": { + "format": "int32", + "description": "Position of the job in question within that queue.", + "type": "integer" + }, + "queueId": { + "description": "Id of the queue this job is enqueued in.", + "minLength": 1, + "type": "string" + }, + "queueLength": { + "format": "int32", + "description": "Length of the queue: total number of enqueued jobs.", + "type": "integer" + }, + "estimatedWaitTimeMinutes": { + "format": "double", + "description": "Estimated wait time of the job rounded up to the nearest minute", + "type": "number" + } + } + }, + "RouterQueue": { + "description": "A queue that can contain jobs to be routed.", + "type": "object", + "properties": { + "id": { + "description": "The Id of this queue", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of this queue.", + "type": "string" + }, + "distributionPolicyId": { + "description": "The ID of the distribution policy that will determine how a job is distributed to workers.", + "type": "string" + }, + "labels": { + "description": "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.", + "type": "object", + "additionalProperties": {} + }, + "exceptionPolicyId": { + "description": "(Optional) The ID of the exception policy that determines various job escalation rules.", + "type": "string" + } + } + }, + "RouterQueueAssignment": { + "description": "An assignment of a worker to a queue", + "type": "object" + }, + "RouterQueueCollection": { + "description": "A paged collection of queues.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouterQueueItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "RouterQueueItem": { + "description": "Paged instance of RouterQueue", + "type": "object", + "properties": { + "queue": { + "$ref": "#/definitions/RouterQueue" + }, + "etag": { + "description": "(Optional) The Concurrency Token.", + "type": "string" + } + } + }, + "RouterQueueSelector": { + "description": "Describes a condition that must be met against a set of labels for queue selection", + "required": [ + "key", + "labelOperator" + ], + "type": "object", + "properties": { + "key": { + "description": "The label key to query against", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "labelOperator": { + "description": "Describes how the value of the label is compared to the value defined on the label selector", + "enum": [ + "equal", + "notEqual", + "lessThan", + "lessThanEqual", + "greaterThan", + "greaterThanEqual" + ], + "type": "string", + "x-ms-enum": { + "name": "LabelOperator", + "modelAsString": true + } + }, + "value": { + "description": "The value to compare against the actual label value with the given operator", + "type": "object" + } + } + }, + "RouterQueueStatistics": { + "description": "Statistics for the queue", + "required": [ + "length", + "queueId" + ], + "type": "object", + "properties": { + "queueId": { + "description": "Id of the queue these details are about.", + "minLength": 1, + "type": "string" + }, + "length": { + "format": "int32", + "description": "Length of the queue: total number of enqueued jobs.", + "type": "integer" + }, + "estimatedWaitTimeMinutes": { + "description": "The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority", + "type": "object", + "additionalProperties": { + "format": "double", + "type": "number" + } + }, + "longestJobWaitTimeMinutes": { + "format": "double", + "description": "The wait time of the job that has been enqueued in this queue for the longest.", + "type": "number" + } + } + }, + "RouterRule": { + "description": "A rule of one of the following types:\r\n \r\nStaticRule: A rule providing static rules that always return the same result, regardless of input.\r\nDirectMapRule: A rule that return the same labels as the input labels.\r\nExpressionRule: A rule providing inline expression rules.\r\nAzureFunctionRule: A rule providing a binding to an HTTP Triggered Azure Function.\r\nWebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol.", "required": [ "kind" ], @@ -2950,6 +3068,7 @@ "type": "object", "properties": { "id": { + "description": "Id of the worker.", "type": "string", "readOnly": true }, @@ -2961,13 +3080,17 @@ "inactive" ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "RouterWorkerState", + "modelAsString": true + } }, "queueAssignments": { "description": "The queue(s) that this worker can receive work from.", "type": "object", "additionalProperties": { - "$ref": "#/definitions/QueueAssignment" + "$ref": "#/definitions/RouterQueueAssignment" } }, "totalCapacity": { @@ -2996,7 +3119,7 @@ "description": "A list of active offers issued to this worker.", "type": "array", "items": { - "$ref": "#/definitions/JobOffer" + "$ref": "#/definitions/RouterJobOffer" }, "readOnly": true }, @@ -3004,7 +3127,7 @@ "description": "A list of assigned jobs attached to this worker.", "type": "array", "items": { - "$ref": "#/definitions/WorkerAssignment" + "$ref": "#/definitions/RouterWorkerAssignment" }, "readOnly": true }, @@ -3020,11 +3143,62 @@ } } }, + "RouterWorkerAssignment": { + "description": "The assignment for a worker to a job", + "required": [ + "assignedAt", + "assignmentId", + "capacityCost", + "jobId" + ], + "type": "object", + "properties": { + "assignmentId": { + "description": "The Id of the assignment.", + "minLength": 1, + "type": "string" + }, + "jobId": { + "description": "The Id of the Job assigned.", + "minLength": 1, + "type": "string" + }, + "capacityCost": { + "format": "int32", + "description": "The amount of capacity this assignment has consumed on the worker.", + "type": "integer" + }, + "assignedAt": { + "format": "date-time", + "description": "The assignment time of the job in UTC.", + "type": "string" + } + } + }, + "RouterWorkerCollection": { + "description": "A paged collection of workers.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouterWorkerItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, "RouterWorkerItem": { "description": "Paged instance of RouterWorker", "type": "object", "properties": { - "routerWorker": { + "worker": { "$ref": "#/definitions/RouterWorker" }, "etag": { @@ -3033,8 +3207,72 @@ } } }, + "RouterWorkerSelector": { + "description": "Describes a condition that must be met against a set of labels for worker selection", + "required": [ + "key", + "labelOperator" + ], + "type": "object", + "properties": { + "key": { + "description": "The label key to query against", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "labelOperator": { + "description": "Describes how the value of the label is compared to the value defined on the label selector", + "enum": [ + "equal", + "notEqual", + "lessThan", + "lessThanEqual", + "greaterThan", + "greaterThanEqual" + ], + "type": "string", + "x-ms-enum": { + "name": "LabelOperator", + "modelAsString": true + } + }, + "value": { + "description": "The value to compare against the actual label value with the given operator", + "type": "object" + }, + "expiresAfterSeconds": { + "format": "double", + "description": "Describes how long this label selector is valid in seconds.", + "type": "number" + }, + "expedite": { + "description": "Pushes the job to the front of the queue as long as this selector is active.", + "type": "boolean" + }, + "status": { + "description": "The status of the worker selector.", + "enum": [ + "active", + "expired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RouterWorkerSelectorStatus", + "modelAsString": true + } + }, + "expiresAt": { + "format": "date-time", + "description": "The time at which this worker selector expires in UTC", + "type": "string", + "readOnly": true + } + } + }, "RuleEngineQueueSelectorAttachment": { - "description": "Attaches labels to a worker when a RouterRule is resolved", + "description": "Attaches queue selectors to a job when the RouterRule is resolved", "required": [ "rule" ], @@ -3046,8 +3284,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing RuleEngineQueueSelectorAttachment", + "type": "string" }, "rule": { "$ref": "#/definitions/RouterRule" @@ -3056,7 +3294,7 @@ "x-ms-discriminator-value": "rule-engine" }, "RuleEngineWorkerSelectorAttachment": { - "description": "Attaches labels to a worker when a RouterRule is resolved", + "description": "Attaches worker selectors to a job when a RouterRule is resolved", "required": [ "rule" ], @@ -3068,8 +3306,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing RuleEngineWorkerSelectorAttachment", + "type": "string" }, "rule": { "$ref": "#/definitions/RouterRule" @@ -3077,13 +3315,24 @@ }, "x-ms-discriminator-value": "rule-engine" }, + "ScheduleAndSuspendMode": { + "description": "Describes a matching mode used for scheduling jobs to be queued at a future time.\r\nAt the specified time, matching worker to a job will not start automatically.", + "type": "object", + "properties": { + "scheduleAt": { + "format": "date-time", + "description": "Scheduled time.", + "type": "string" + } + } + }, "ScoringRuleOptions": { "description": "Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode", "type": "object", "properties": { "batchSize": { "format": "int32", - "description": "(Optional) Set batch size when AllowScoringBatchOfWorkers is set to true", + "description": "(Optional) Set batch size when AllowScoringBatchOfWorkers is set to true. Defaults to 20 if not configured.", "type": "integer" }, "scoringParameters": { @@ -3098,7 +3347,7 @@ "type": "string", "x-ms-enum": { "name": "ScoringRuleParameterSelector", - "modelAsString": false + "modelAsString": true } } }, @@ -3113,9 +3362,9 @@ } }, "StaticQueueSelectorAttachment": { - "description": "Describes a label selector that will always be attached", + "description": "Describes a queue selector that will be attached to the job", "required": [ - "labelSelector" + "queueSelector" ], "type": "object", "allOf": [ @@ -3125,16 +3374,16 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing StaticQueueSelectorAttachment", + "type": "string" }, - "labelSelector": { - "$ref": "#/definitions/QueueSelector" + "queueSelector": { + "$ref": "#/definitions/RouterQueueSelector" } }, "x-ms-discriminator-value": "static" }, - "StaticRule": { + "StaticRouterRule": { "description": "A rule providing static rules that always return the same result, regardless of input.", "type": "object", "allOf": [ @@ -3144,6 +3393,7 @@ ], "properties": { "kind": { + "description": "The type discriminator describing StaticRouterRule", "type": "string" }, "value": { @@ -3156,9 +3406,9 @@ "x-ms-discriminator-value": "static-rule" }, "StaticWorkerSelectorAttachment": { - "description": "Describes a label selector that will always be attached", + "description": "Describes a worker selector that will be attached to the job", "required": [ - "labelSelector" + "workerSelector" ], "type": "object", "allOf": [ @@ -3168,15 +3418,29 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing StaticWorkerSelectorAttachment", + "type": "string" }, - "labelSelector": { - "$ref": "#/definitions/WorkerSelector" + "workerSelector": { + "$ref": "#/definitions/RouterWorkerSelector" } }, "x-ms-discriminator-value": "static" }, + "SuspendMode": { + "description": "Describes a matching mode where matching worker to a job is suspended.", + "type": "object" + }, + "UnassignJobRequest": { + "description": "Request payload for unassigning a job.", + "type": "object", + "properties": { + "suspendMatching": { + "description": "If SuspendMatching is true, then the job is not queued for re-matching with a worker.", + "type": "boolean" + } + } + }, "UnassignJobResult": { "description": "Response payload after a job has been successfully unassigned.", "required": [ @@ -3187,6 +3451,7 @@ "properties": { "jobId": { "description": "The Id of the job unassigned.", + "minLength": 1, "type": "string" }, "unassignmentCount": { @@ -3204,11 +3469,12 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/JobExceptionTrigger" + "$ref": "#/definitions/ExceptionTrigger" } ], "properties": { "kind": { + "description": "The type discriminator describing a sub-type of WaitTimeExceptionTrigger", "type": "string" }, "thresholdSeconds": { @@ -3219,8 +3485,37 @@ }, "x-ms-discriminator-value": "wait-time" }, + "WebhookRouterRule": { + "description": "A rule providing a binding to an external web server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RouterRule" + } + ], + "properties": { + "kind": { + "description": "The type discriminator describing WebhookRouterRule", + "type": "string" + }, + "authorizationServerUri": { + "format": "uri", + "description": "Uri for Authorization Server.", + "type": "string" + }, + "clientCredential": { + "$ref": "#/definitions/Oauth2ClientCredential" + }, + "webhookUri": { + "format": "uri", + "description": "Uri for Contoso's Web Server.", + "type": "string" + } + }, + "x-ms-discriminator-value": "webhook-rule" + }, "WeightedAllocationQueueSelectorAttachment": { - "description": "Describes multiple sets of label selectors, of which one will be selected and attached according to a weighting", + "description": "Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting", "required": [ "allocations" ], @@ -3232,8 +3527,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing WeightedAllocationQueueSelectorAttachment", + "type": "string" }, "allocations": { "description": "A collection of percentage based weighted allocations.", @@ -3246,7 +3541,7 @@ "x-ms-discriminator-value": "weighted-allocation-queue-selector" }, "WeightedAllocationWorkerSelectorAttachment": { - "description": "Describes multiple sets of label selectors, of which one will be selected and attached according to a weighting", + "description": "Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting", "required": [ "allocations" ], @@ -3258,8 +3553,8 @@ ], "properties": { "kind": { - "type": "string", - "readOnly": true + "description": "The type discriminator describing WeightedAllocationWorkerSelectorAttachment", + "type": "string" }, "allocations": { "description": "A collection of percentage based weighted allocations.", @@ -3271,138 +3566,25 @@ }, "x-ms-discriminator-value": "weighted-allocation-worker-selector" }, - "WorkerAssignment": { - "description": "The assignment for a worker to a job", - "required": [ - "assignTime", - "capacityCost", - "id", - "jobId" - ], - "type": "object", - "properties": { - "id": { - "description": "The Id of the assignment.", - "type": "string" - }, - "jobId": { - "description": "The Id of the Job assigned.", - "type": "string" - }, - "capacityCost": { - "format": "int32", - "description": "The amount of capacity this assignment has consumed on the worker.", - "type": "integer" - }, - "assignTime": { - "format": "date-time", - "description": "The assignment time of the job.", - "type": "string" - } - } - }, - "WorkerCollection": { - "description": "A paged collection of workers.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RouterWorkerItem" - } - }, - "nextLink": { - "type": "string", - "readOnly": true - } - } - }, - "WorkerSelector": { - "description": "Describes a condition that must be met against a set of labels for worker selection", - "required": [ - "key", - "labelOperator" - ], - "type": "object", - "properties": { - "key": { - "description": "The label key to query against", - "maxLength": 500, - "minLength": 0, - "type": "string" - }, - "labelOperator": { - "description": "Describes how the value of the label is compared to the value defined on the label selector", - "enum": [ - "equal", - "notEqual", - "lessThan", - "lessThanEqual", - "greaterThan", - "greaterThanEqual" - ], - "type": "string", - "x-ms-enum": { - "name": "LabelOperator", - "modelAsString": false - } - }, - "value": { - "description": "The value to compare against the actual label value with the given operator", - "type": "object" - }, - "ttlSeconds": { - "format": "double", - "description": "Describes how long this label selector is valid in seconds.", - "type": "number" - }, - "expedite": { - "description": "Pushes the job to the front of the queue as long as this selector is active.", - "type": "boolean" - }, - "state": { - "description": "The state of the worker selector.", - "enum": [ - "active", - "expired" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "WorkerSelectorState", - "modelAsString": false - } - }, - "expireTime": { - "format": "date-time", - "description": "The time at which this worker selector expires in UTC", - "type": "string", - "readOnly": true - } - } - }, "WorkerSelectorAttachment": { - "description": "An attachment which attaches WorkerSelectors to workers", + "description": "An attachment which attaches worker selectors to a job", "required": [ "kind" ], "type": "object", "properties": { "kind": { - "description": "The type discriminator describing the type of label selector attachment", + "description": "The type discriminator describing the type of worker selector attachment", "type": "string" } }, "discriminator": "kind" }, "WorkerWeightedAllocation": { - "description": "Contains the weight percentage and label selectors to be applied if selected for weighted distributions.", + "description": "Contains the weight percentage and worker selectors to be applied if selected for weighted distributions.", "required": [ - "labelSelectors", - "weight" + "weight", + "workerSelectors" ], "type": "object", "properties": { @@ -3411,11 +3593,11 @@ "description": "The percentage of this weight, expressed as a fraction of 1.", "type": "number" }, - "labelSelectors": { - "description": "A collection of label selectors that will be applied if this allocation is selected.", + "workerSelectors": { + "description": "A collection of worker selectors that will be applied if this allocation is selected.", "type": "array", "items": { - "$ref": "#/definitions/WorkerSelector" + "$ref": "#/definitions/RouterWorkerSelector" } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_CreateClassificationPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_CreateClassificationPolicy.json index 8ff5b248bcac..43c4382c23d6 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_CreateClassificationPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_CreateClassificationPolicy.json @@ -14,7 +14,7 @@ "language": "PowerFx", "expression": "1 = 1" }, - "labelSelectors": [ + "queueSelectors": [ { "key": "foo", "labelOperator": "equal", @@ -43,7 +43,36 @@ "language": "PowerFx", "expression": "1 = 1" }, - "labelSelectors": [ + "queueSelectors": [ + { + "key": "foo", + "labelOperator": "equal", + "value": "bar" + } + ] + } + ], + "prioritizationRule": { + "kind": "static-rule", + "value": "2" + }, + "workerSelectors": [] + } + }, + "201": { + "body": { + "id": "90eb00c4-234e-4df7-a231-ef7895518384", + "name": "Main", + "fallbackQueueId": "MainQueue", + "queueSelectors": [ + { + "kind": "conditional", + "condition": { + "kind": "expression-rule", + "language": "PowerFx", + "expression": "1 = 1" + }, + "queueSelectors": [ { "key": "foo", "labelOperator": "equal", diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_GetClassificationPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_GetClassificationPolicy.json index 856b2693e158..0129b480c958 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_GetClassificationPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_GetClassificationPolicy.json @@ -18,7 +18,7 @@ "language": "PowerFx", "expression": "1 = 1" }, - "labelSelectors": [ + "queueSelectors": [ { "key": "foo", "labelOperator": "equal", @@ -35,7 +35,7 @@ { "kind": "pass-through", "key": "language", - "operator": "equal" + "labelOperator": "equal" } ] } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_UpdateClassificationPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_UpdateClassificationPolicy.json index 11248d69cb78..db256e6c1a95 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_UpdateClassificationPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ClassificationPolicies_UpdateClassificationPolicy.json @@ -21,10 +21,39 @@ "language": "PowerFx", "expression": "1 = 1" }, - "labelSelectors": [ + "queueSelectors": [ { "key": "foo", - "operator": "equal", + "labelOperator": "equal", + "value": "bar" + } + ] + } + ], + "prioritizationRule": { + "kind": "static-rule", + "value": "2" + }, + "workerSelectors": [] + } + }, + "201": { + "body": { + "id": "90eb00c4-234e-4df7-a231-ef7895518384", + "name": "MainUpdate", + "fallbackQueueId": "MainQueue", + "queueSelectors": [ + { + "kind": "conditional", + "condition": { + "kind": "expression-rule", + "language": "PowerFx", + "expression": "1 = 1" + }, + "queueSelectors": [ + { + "key": "foo", + "labelOperator": "equal", "value": "bar" } ] diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_CreateDistributionPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_CreateDistributionPolicy.json index 423edaf76c58..e64543f59711 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_CreateDistributionPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_CreateDistributionPolicy.json @@ -10,7 +10,7 @@ "maxConcurrentOffers": 5, "bypassSelectors": false }, - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, "name": "Main" } }, @@ -19,7 +19,20 @@ "body": { "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4", "name": "Main", - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, + "mode": { + "kind": "longest-idle", + "minConcurrentOffers": 1, + "maxConcurrentOffers": 5, + "bypassSelectors": false + } + } + }, + "201": { + "body": { + "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4", + "name": "Main", + "offerExpiresAfterSeconds": 300, "mode": { "kind": "longest-idle", "minConcurrentOffers": 1, diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_GetDistributionPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_GetDistributionPolicy.json index a626db14e183..458ff4f53e99 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_GetDistributionPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_GetDistributionPolicy.json @@ -9,7 +9,7 @@ "body": { "id": "MainDistributionPolicy", "name": "Main", - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, "mode": { "kind": "longest-idle", "minConcurrentOffers": 1, diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_ListDistributionPoliciesWithPageSize.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_ListDistributionPoliciesWithPageSize.json index 92f63e7c748f..5cbbe1e72b9e 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_ListDistributionPoliciesWithPageSize.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_ListDistributionPoliciesWithPageSize.json @@ -12,7 +12,7 @@ "distributionPolicy": { "id": "SecondaryDistributionPolicy", "name": "Secondary", - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, "mode": { "kind": "round-robin", "minConcurrentOffers": 1, @@ -26,7 +26,7 @@ "distributionPolicy": { "id": "MainDistributionPolicy", "name": "Main", - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, "mode": { "kind": "longest-idle", "minConcurrentOffers": 1, diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_UpdateDistributionPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_UpdateDistributionPolicy.json index 423edaf76c58..e64543f59711 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_UpdateDistributionPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/DistributionPolicies_UpdateDistributionPolicy.json @@ -10,7 +10,7 @@ "maxConcurrentOffers": 5, "bypassSelectors": false }, - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, "name": "Main" } }, @@ -19,7 +19,20 @@ "body": { "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4", "name": "Main", - "offerTtlSeconds": 300, + "offerExpiresAfterSeconds": 300, + "mode": { + "kind": "longest-idle", + "minConcurrentOffers": 1, + "maxConcurrentOffers": 5, + "bypassSelectors": false + } + } + }, + "201": { + "body": { + "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4", + "name": "Main", + "offerExpiresAfterSeconds": 300, "mode": { "kind": "longest-idle", "minConcurrentOffers": 1, diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_CreateExceptionPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_CreateExceptionPolicy.json index bd1324978c74..f932e59c4a6e 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_CreateExceptionPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_CreateExceptionPolicy.json @@ -47,6 +47,29 @@ } } } + }, + "201": { + "body": { + "id": "cf1cda69-6f41-45ac-b252-213293f1b1cb", + "name": "Main", + "exceptionRules": { + "MaxWaitTimeExceeded": { + "trigger": { + "kind": "wait-time", + "thresholdSeconds": 20 + }, + "actions": { + "MoveJobToEscalatedQueue": { + "kind": "reclassify", + "classificationPolicyId": "Main", + "labelsToUpsert": { + "escalated": true + } + } + } + } + } + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_UpdateExceptionPolicy.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_UpdateExceptionPolicy.json index dd5e5f365943..860e98a4bd25 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_UpdateExceptionPolicy.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/ExceptionPolicies_UpdateExceptionPolicy.json @@ -47,6 +47,29 @@ } } } + }, + "201": { + "body": { + "id": "cf1cda69-6f41-45ac-b252-213293f1b1cb", + "name": "Main test", + "exceptionRules": { + "MaxWaitTimeExceeded": { + "trigger": { + "kind": "wait-time", + "thresholdSeconds": 20 + }, + "actions": { + "MoveJobToEscalatedQueue": { + "kind": "reclassify", + "classificationPolicyId": "Main", + "labelsToUpsert": { + "escalated": true + } + } + } + } + } + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CloseJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CloseJob.json index 116e379e6d5a..3ef1667ada2a 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CloseJob.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CloseJob.json @@ -5,7 +5,8 @@ "id": "8780b28c-7079-4de1-9143-4d369289e958", "closeJobRequest": { "assignmentId": "1d5896f3-8b54-40be-82d3-910323f5e2af", - "dispositionCode": "JobCompleted." + "dispositionCode": "JobCompleted.", + "note": "Closing job" } }, "responses": { diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CompleteJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CompleteJob.json index 2317cc2084e5..5e4cb3ce3c1b 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CompleteJob.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CompleteJob.json @@ -4,7 +4,8 @@ "api-version": "2022-07-18-preview", "id": "8780b28c-7079-4de1-9143-4d369289e958", "completeJobRequest": { - "assignmentId": "1d5896f3-8b54-40be-82d3-910323f5e2af" + "assignmentId": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "note": "Completing job" } }, "responses": { diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateJob.json index c23e72f4faf8..ceab14d181b5 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateJob.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateJob.json @@ -15,7 +15,13 @@ "value": true } ], - "labels": {} + "labels": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } } }, "responses": { @@ -23,8 +29,39 @@ "body": { "id": "JobId", "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", - "jobStatus": "queued", - "enqueueTimeUtc": "2021-09-30T23:59:04.5311999+00:00", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", + "channelId": "CustomChatChannel", + "classificationPolicyId": null, + "queueId": "MainQueue", + "priority": 5, + "dispositionCode": null, + "requestedWorkerSelectors": [ + { + "key": "Sales", + "labelOperator": "equal", + "value": true, + "expiresAfterSeconds": null + } + ], + "attachedWorkerSelectors": [], + "labels": {}, + "assignments": {}, + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } + } + }, + "201": { + "body": { + "id": "JobId", + "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", "channelId": "CustomChatChannel", "classificationPolicyId": null, "queueId": "MainQueue", @@ -35,13 +72,19 @@ "key": "Sales", "labelOperator": "equal", "value": true, - "ttlSeconds": null + "expiresAfterSeconds": null } ], "attachedWorkerSelectors": [], "labels": {}, "assignments": {}, - "notes": {} + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateScheduledJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateScheduledJob.json new file mode 100644 index 000000000000..f194ed2bf6b1 --- /dev/null +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_CreateScheduledJob.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2022-07-18-preview", + "id": "JobId", + "patch": { + "channelId": "CustomChatChannel", + "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "queueId": "MainQueue", + "priority": 5, + "requestedWorkerSelectors": [ + { + "key": "Sales", + "labelOperator": "equal", + "value": true + } + ], + "labels": {}, + "matchingMode": { + "modeType": "scheduleAndSuspendMode", + "queueAndMatchMode": null, + "scheduleAndSuspendMode": { + "scheduleAt": "2023-05-26T23:22:12.0774222+00:00" + }, + "suspendMode": null + } + } + }, + "responses": { + "200": { + "body": { + "id": "JobId", + "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", + "channelId": "CustomChatChannel", + "classificationPolicyId": null, + "queueId": "MainQueue", + "priority": 5, + "dispositionCode": null, + "requestedWorkerSelectors": [ + { + "key": "Sales", + "labelOperator": "equal", + "value": true, + "expiresAfterSeconds": null + } + ], + "attachedWorkerSelectors": [], + "labels": {}, + "assignments": {}, + "notes": {}, + "matchingMode": { + "modeType": "scheduleAndSuspendMode", + "queueAndMatchMode": null, + "scheduleAndSuspendMode": { + "scheduleAt": "2023-05-26T23:22:12.0774222+00:00" + }, + "suspendMode": null + }, + "scheduledAt": null + } + }, + "201": { + "body": { + "id": "JobId", + "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", + "channelId": "CustomChatChannel", + "classificationPolicyId": null, + "queueId": "MainQueue", + "priority": 5, + "dispositionCode": null, + "requestedWorkerSelectors": [ + { + "key": "Sales", + "labelOperator": "equal", + "value": true, + "expiresAfterSeconds": null + } + ], + "attachedWorkerSelectors": [], + "labels": {}, + "assignments": {}, + "notes": {}, + "matchingMode": { + "modeType": "scheduleAndSuspendMode", + "queueAndMatchMode": null, + "scheduleAndSuspendMode": { + "scheduleAt": "2023-05-26T23:22:12.0774222+00:00" + }, + "suspendMode": null + }, + "scheduledAt": null + } + } + } +} diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJob.json index 59ea8f552e52..4281ace192f4 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJob.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJob.json @@ -9,8 +9,8 @@ "body": { "id": "8780b28c-7079-4de1-9143-4d369289e958", "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", - "jobStatus": "queued", - "enqueueTimeUtc": "2021-09-30T23:59:04.5311999+00:00", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", "channelId": "CustomVoiceChannel", "classificationPolicyId": null, "queueId": "MainQueue", @@ -21,13 +21,19 @@ "key": "Sales", "labelOperator": "equal", "value": true, - "ttlSeconds": null + "expiresAfterSeconds": null } ], "attachedWorkerSelectors": [], "labels": {}, "assignments": {}, - "notes": {} + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJobsWithPageSize.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJobsWithPageSize.json index c50b00b3580e..21603b03288e 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJobsWithPageSize.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_GetJobsWithPageSize.json @@ -12,11 +12,11 @@ "body": { "value": [ { - "routerJob": { + "job": { "id": "383541b3-5637-4af6-8aac-3391da8a578a", "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", - "jobStatus": "queued", - "enqueueTimeUtc": "2021-09-30T23:56:21.883322+00:00", + "status": "queued", + "enqueuedAt": "2021-09-30T23:56:21.883322+00:00", "channelId": "CustomChatChannel", "classificationPolicyId": null, "queueId": "MainQueue", @@ -24,16 +24,22 @@ "dispositionCode": null, "labels": {}, "assignments": {}, - "notes": {} + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } }, "etag": "etag" }, { - "routerJob": { + "job": { "id": "c571dd84-1ca7-4606-a77a-f38d9e4ae513", "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", - "jobStatus": "queued", - "enqueueTimeUtc": "2021-09-30T23:57:54.041179+00:00", + "status": "queued", + "enqueuedAt": "2021-09-30T23:57:54.041179+00:00", "channelId": "CustomChatChannel2", "classificationPolicyId": null, "queueId": "MainQueue", @@ -41,7 +47,13 @@ "dispositionCode": null, "labels": {}, "assignments": {}, - "notes": {} + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } }, "etag": "etag" } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UnassignJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UnassignJob.json index 4ea1116b082b..3c4f782d560b 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UnassignJob.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UnassignJob.json @@ -3,7 +3,10 @@ "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2022-07-18-preview", "id": "8780b28c-7079-4de1-9143-4d369289e958", - "assignmentId": "1d5896f3-8b54-40be-82d3-910323f5e2af" + "assignmentId": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "unassignJobRequest": { + "suspendMatching": false + } }, "responses": { "200": { diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UpdateJob.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UpdateJob.json index d9acf28bab39..8190f25baaad 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UpdateJob.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Jobs_UpdateJob.json @@ -12,8 +12,8 @@ "body": { "id": "383541b3-5637-4af6-8aac-3391da8a578a", "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", - "jobStatus": "queued", - "enqueueTimeUtc": "2021-09-30T23:59:04.5311999+00:00", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", "channelId": "CustomVoiceChannel", "classificationPolicyId": null, "queueId": "MainQueue", @@ -24,13 +24,50 @@ "key": "Sales", "labelOperator": "equal", "value": true, - "ttlSeconds": null + "expiresAfterSeconds": null } ], "attachedWorkerSelectors": [], "labels": {}, "assignments": {}, - "notes": {} + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } + } + }, + "201": { + "body": { + "id": "383541b3-5637-4af6-8aac-3391da8a578a", + "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "status": "queued", + "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00", + "channelId": "CustomVoiceChannel", + "classificationPolicyId": null, + "queueId": "MainQueue", + "priority": 5, + "dispositionCode": null, + "requestedWorkerSelectors": [ + { + "key": "Sales", + "labelOperator": "equal", + "value": true, + "expiresAfterSeconds": null + } + ], + "attachedWorkerSelectors": [], + "labels": {}, + "assignments": {}, + "notes": {}, + "matchingMode": { + "modeType": "queueAndMatchMode", + "queueAndMatchMode": {}, + "scheduleAndSuspendMode": null, + "suspendMode": null + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Offers_DeclineJobOffer.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Offers_DeclineJobOffer.json index b95b2306fdd3..a0fffb9fa735 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Offers_DeclineJobOffer.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Offers_DeclineJobOffer.json @@ -3,7 +3,10 @@ "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2022-07-18-preview", "workerId": "DefaultWorker", - "offerId": "1d5896f3-8b54-40be-82d3-910323f5e2af" + "offerId": "1d5896f3-8b54-40be-82d3-910323f5e2af", + "declineJobOfferRequest": { + "retryOfferAt": "2023-05-26T00:00:00.0000000Z" + } }, "responses": { "200": { diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_CreateQueue.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_CreateQueue.json index 516ddc8ee317..9d62d76d3c22 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_CreateQueue.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_CreateQueue.json @@ -8,9 +8,7 @@ "name": "Main", "labels": {}, "exceptionPolicyId": "MainExceptionPolicy" - }, - "repeatabilityRequestId": "5aac88f9-d24a-4c53-9d90-86a801667cbe", - "repeatabilityFirstSent": "Tue, 23 Nov 2021 08:49:37 GMT" + } }, "responses": { "200": { @@ -21,6 +19,15 @@ "labels": {}, "exceptionPolicyId": "MainExceptionPolicy" } + }, + "201": { + "body": { + "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68", + "name": "Main", + "distributionPolicyId": "MainDistributionPolicy", + "labels": {}, + "exceptionPolicyId": "MainExceptionPolicy" + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_ListQueuesWithPageSize.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_ListQueuesWithPageSize.json index 83c42f9feac1..931f665e05d2 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_ListQueuesWithPageSize.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_ListQueuesWithPageSize.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "jobQueue": { + "queue": { "id": "MainQueue", "name": "Main", "distributionPolicyId": "MainDistributionPolicy", @@ -19,7 +19,7 @@ "etag": "etag" }, { - "jobQueue": { + "queue": { "id": "SecondaryQueue", "name": "Secondary", "distributionPolicyId": "SecondaryDistributionPolicy", diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_UpdateQueue.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_UpdateQueue.json index b2546df698d0..29f8024b1908 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_UpdateQueue.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Queues_UpdateQueue.json @@ -17,6 +17,15 @@ "labels": {}, "exceptionPolicyId": "MainExceptionPolicy" } + }, + "201": { + "body": { + "id": "MainQueue", + "name": "Main", + "distributionPolicyId": "MainDistributionPolicy", + "labels": {}, + "exceptionPolicyId": "MainExceptionPolicy" + } } } } diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_CreateWorker.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_CreateWorker.json index 6cee0f131a8d..214f7a895dd0 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_CreateWorker.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_CreateWorker.json @@ -13,10 +13,12 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "availableForOffers": false @@ -35,10 +37,38 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 + } + }, + "offers": [], + "assignedJobs": [], + "loadRatio": 0, + "availableForOffers": false + } + }, + "201": { + "body": { + "id": "WorkerId", + "state": "inactive", + "queueAssignments": { + "MainQueue": {} + }, + "totalCapacity": 10, + "labels": {}, + "tags": {}, + "channelConfigurations": { + "CustomChatChannel": { + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 + }, + "CustomVoiceChannel": { + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterActiveWorker.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterActiveWorker.json index d4c7d38068f6..548b2074f72a 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterActiveWorker.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterActiveWorker.json @@ -21,10 +21,38 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 + } + }, + "offers": [], + "assignedJobs": [], + "loadRatio": 0, + "availableForOffers": false + } + }, + "201": { + "body": { + "id": "WorkerId", + "state": "draining", + "queueAssignments": { + "MainQueue": {} + }, + "totalCapacity": 10, + "labels": {}, + "tags": {}, + "channelConfigurations": { + "CustomChatChannel": { + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 + }, + "CustomVoiceChannel": { + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterInactiveWorker.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterInactiveWorker.json index 4dc70bac9356..08ae919f625a 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterInactiveWorker.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_DeregisterInactiveWorker.json @@ -21,10 +21,38 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 + } + }, + "offers": [], + "assignedJobs": [], + "loadRatio": 0, + "availableForOffers": false + } + }, + "201": { + "body": { + "id": "WorkerId", + "state": "inactive", + "queueAssignments": { + "MainQueue": {} + }, + "totalCapacity": 10, + "labels": {}, + "tags": {}, + "channelConfigurations": { + "CustomChatChannel": { + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 + }, + "CustomVoiceChannel": { + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetAvailableWorkersByChannel.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetAvailableWorkersByChannel.json index d3ae0d142b7c..49872a55c30d 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetAvailableWorkersByChannel.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetAvailableWorkersByChannel.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2022-07-18-preview", - "status": "active", + "state": "active", "channelId": "CustomChatChannel", "hasCapacity": true }, @@ -11,7 +11,7 @@ "body": { "value": [ { - "routerWorker": { + "worker": { "id": "DefaultWorker", "state": "active", "queueAssignments": { @@ -23,10 +23,12 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 100 + "capacityCostPerJob": 100, + "maxNumberOfJobs": 1 } }, "offers": [], @@ -37,7 +39,7 @@ "etag": "etag" }, { - "routerWorker": { + "worker": { "id": "SecondWorker", "state": "active", "queueAssignments": { @@ -49,10 +51,12 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 100 + "capacityCostPerJob": 100, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetWorkersWithPageSize.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetWorkersWithPageSize.json index 3748c4bb48d9..fa43399597a4 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetWorkersWithPageSize.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_GetWorkersWithPageSize.json @@ -9,7 +9,7 @@ "body": { "value": [ { - "routerWorker": { + "worker": { "id": "DefaultWorker", "state": "active", "queueAssignments": { @@ -21,10 +21,12 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 100 + "capacityCostPerJob": 100, + "maxNumberOfJobs": 1 } }, "offers": [], @@ -35,7 +37,7 @@ "etag": "etag" }, { - "routerWorker": { + "worker": { "id": "SecondWorker", "state": "active", "queueAssignments": { @@ -47,10 +49,12 @@ "tags": {}, "channelConfigurations": { "CustomEmailChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 4 }, "CustomSMSChannel": { - "capacityCostPerJob": 100 + "capacityCostPerJob": 100, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_RegisterWorker.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_RegisterWorker.json index bcd1f5a365b3..04040fd1df99 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_RegisterWorker.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_RegisterWorker.json @@ -21,10 +21,38 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 + } + }, + "offers": [], + "assignedJobs": [], + "loadRatio": 0, + "availableForOffers": true + } + }, + "201": { + "body": { + "id": "WorkerId", + "state": "active", + "queueAssignments": { + "MainQueue": {} + }, + "totalCapacity": 10, + "labels": {}, + "tags": {}, + "channelConfigurations": { + "CustomChatChannel": { + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 + }, + "CustomVoiceChannel": { + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_UpdateWorker.json b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_UpdateWorker.json index 6cee0f131a8d..214f7a895dd0 100644 --- a/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_UpdateWorker.json +++ b/specification/communication/data-plane/JobRouter/preview/2022-07-18-preview/examples/Workers_UpdateWorker.json @@ -13,10 +13,12 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "availableForOffers": false @@ -35,10 +37,38 @@ "tags": {}, "channelConfigurations": { "CustomChatChannel": { - "capacityCostPerJob": 11 + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 }, "CustomVoiceChannel": { - "capacityCostPerJob": 10 + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 + } + }, + "offers": [], + "assignedJobs": [], + "loadRatio": 0, + "availableForOffers": false + } + }, + "201": { + "body": { + "id": "WorkerId", + "state": "inactive", + "queueAssignments": { + "MainQueue": {} + }, + "totalCapacity": 10, + "labels": {}, + "tags": {}, + "channelConfigurations": { + "CustomChatChannel": { + "capacityCostPerJob": 11, + "maxNumberOfJobs": 4 + }, + "CustomVoiceChannel": { + "capacityCostPerJob": 10, + "maxNumberOfJobs": 1 } }, "offers": [], diff --git a/specification/communication/data-plane/JobRouter/readme.md b/specification/communication/data-plane/JobRouter/readme.md index 63e7979b2c1b..9fb06a381347 100644 --- a/specification/communication/data-plane/JobRouter/readme.md +++ b/specification/communication/data-plane/JobRouter/readme.md @@ -55,12 +55,6 @@ directive: transform: > $.type = "object"; $.additionalProperties["$ref"] = "#/definitions/ExceptionAction"; - -# Rename CommunicationError to JobRouterError - - from: swagger-document - where: '$.definitions.CommunicationError' - transform: > - $["x-ms-client-name"] = "JobRouterError"; ``` diff --git a/specification/confidentialledger/Microsoft.ManagedCcf/proposals.tsp b/specification/confidentialledger/Microsoft.ManagedCcf/proposals.tsp index 592cc3207a39..f72944c36b49 100644 --- a/specification/confidentialledger/Microsoft.ManagedCcf/proposals.tsp +++ b/specification/confidentialledger/Microsoft.ManagedCcf/proposals.tsp @@ -132,6 +132,7 @@ interface Proposals { TxIdReadHeader >; + #suppress "@azure-tools/typespec-azure-core/verb-conflict" "MUST fix in next update" @doc("Returns actions contained in a proposal.") @TypeSpec.Rest.action("actions") @TypeSpec.Rest.actionSeparator("/") diff --git a/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp b/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp index b669dcafe8b0..98ef94f969b2 100644 --- a/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp +++ b/specification/confidentialledger/Microsoft.ManagedCcf/service_state.tsp @@ -210,8 +210,8 @@ model JoinPolicy { @doc("Join policy fields specific to nodes running on AMD SEV-SNP hardware.") model SnpJoinPolicy { ...JoinPolicy; - // TODO: Work out what the actual types of these are + // TODO: Work out what the actual types of these are @doc("Collection of acceptable host data values.") hostData: Record; diff --git a/specification/confidentialledger/Microsoft.ManagedCcf/transactions.tsp b/specification/confidentialledger/Microsoft.ManagedCcf/transactions.tsp index 7b9392987dca..0c91ea509824 100644 --- a/specification/confidentialledger/Microsoft.ManagedCcf/transactions.tsp +++ b/specification/confidentialledger/Microsoft.ManagedCcf/transactions.tsp @@ -36,6 +36,7 @@ model NamedTransaction { @visibility("query") @key transactionId: transactionId; + ...Transaction; } @@ -49,6 +50,7 @@ model CommittedTransaction { @doc("Identifier of committed transaction.") transactionId: transactionId; + ...Transaction; } diff --git a/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json b/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json index 6dbbba8a23c8..382570ddf7e8 100644 --- a/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json +++ b/specification/confidentialledger/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/mccfgov.json @@ -32,59 +32,56 @@ "responses": { "200": { "description": "The request has succeeded.", - "headers": { - "x-ms-ccf-transaction-id": { - "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", - "type": "string", - "pattern": "^[0-9]+\\.[0-9]+$" - } - }, "schema": { "type": "object", + "description": "Paged collection of Proposal items", "properties": { "value": { "type": "array", + "description": "The Proposal items on this page", "items": { "$ref": "#/definitions/Proposals.Proposal" }, - "x-ms-identifiers": [], - "description": "The Proposal items on this page", - "x-typespec-name": "Proposals.Proposal[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of Proposal items", "required": [ "value" - ], - "x-typespec-name": "Azure.Core.Foundations.CustomPage" + ] + }, + "headers": { + "x-ms-ccf-transaction-id": { + "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", + "type": "string", + "pattern": "^[0-9]+\\.[0-9]+$" + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Proposals_List": { "$ref": "./examples/Proposals_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -92,6 +89,9 @@ "post": { "operationId": "Proposals_Withdraw", "description": "Withdraw an existing proposal. Only the original proposer is permitted to withdraw.", + "consumes": [ + "application/cose" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -99,8 +99,8 @@ { "name": "proposalId", "in": "path", - "required": true, "description": "Unique ID assigned to this proposal at its submission, by the service.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, @@ -111,33 +111,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Proposals.Proposal" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Proposals.Proposal" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cose" - ], "x-ms-examples": { "Proposals_Withdraw": { "$ref": "./examples/Proposals_Withdraw.json" @@ -156,8 +153,8 @@ { "name": "proposalId", "in": "path", - "required": true, "description": "Unique ID assigned to this proposal at its submission, by the service.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -165,27 +162,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Proposals.Proposal" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Proposals.Proposal" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -207,8 +204,8 @@ { "name": "proposalId", "in": "path", - "required": true, "description": "Unique ID assigned to this proposal at its submission, by the service.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -216,27 +213,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Proposals.ProposalActions" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Proposals.ProposalActions" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -251,6 +248,9 @@ "post": { "operationId": "Ballots_Submit", "description": "Submit an executable ballot for a specific proposal. This may be as simple as `return true` to vote in favour, or contain reads from the KV and conditions on the proposal contents.", + "consumes": [ + "application/cose" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -258,16 +258,16 @@ { "name": "proposalId", "in": "path", - "required": true, "description": "Unique ID assigned to this proposal at its submission, by the service.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "name": "memberId", "in": "path", - "required": true, "description": "ID of CCF member who signed and submitted this ballot.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, @@ -278,33 +278,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Proposals.Proposal" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Proposals.Proposal" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cose" - ], "x-ms-examples": { "Ballots_Submit": { "$ref": "./examples/Ballots_Submit.json" @@ -316,6 +313,10 @@ "get": { "operationId": "Ballots_Get", "description": "Returns a member's submitted ballot.", + "produces": [ + "text/javascript", + "application/json" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -323,16 +324,16 @@ { "name": "proposalId", "in": "path", - "required": true, "description": "Unique ID assigned to this proposal at its submission, by the service.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "name": "memberId", "in": "path", - "required": true, "description": "ID of CCF member who signed and submitted this ballot.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -340,34 +341,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Proposals.Ballot" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Proposals.Ballot" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "produces": [ - "text/javascript", - "application/json" - ], "x-ms-examples": { "Ballots_Get": { "$ref": "./examples/Ballots_Get.json" @@ -379,6 +376,9 @@ "post": { "operationId": "Proposals_Create", "description": "Submit a proposed change to the service. This will be assigned an ID by the service. Submitting the same signature (including signed COSE headers such as created_at) multiple times will be treated as a single idempotent operation, returning a single created proposal (or an error if it is no longer available). Any change to the request body will be treated as a new, separate proposal.", + "consumes": [ + "application/cose" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -390,33 +390,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Proposals.Proposal" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Proposals.Proposal" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cose" - ], "x-ms-examples": { "Proposals_Create": { "$ref": "./examples/Proposals_Create.json" @@ -428,6 +425,9 @@ "post": { "operationId": "StateDigests_Update", "description": "Request that this member's stateDigest is updated to a fresher value. Only this member may update their own stateDigest. Returns the refreshed value.", + "consumes": [ + "application/cose" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -435,8 +435,8 @@ { "name": "memberId", "in": "path", - "required": true, "description": "Identifier for member this stateDigest applies to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, @@ -447,33 +447,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Acks.StateDigest" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction where this request produced a write on the service. This uniquely identifies the submitted request, and can be used to confirm that the request becomes committed.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Acks.StateDigest" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cose" - ], "x-ms-examples": { "StateDigests_Update": { "$ref": "./examples/StateDigests_Update.json" @@ -485,6 +482,9 @@ "post": { "operationId": "StateDigests_Acknowledge", "description": "Submit a signed acknowledgement of a recent digest of the service status, to transition the member to Active.", + "consumes": [ + "application/cose" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -492,8 +492,8 @@ { "name": "memberId", "in": "path", - "required": true, "description": "Identifier for member this stateDigest applies to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, @@ -514,20 +514,17 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cose" - ], "x-ms-examples": { "StateDigests_Acknowledge": { "$ref": "./examples/StateDigests_Acknowledge.json" @@ -546,8 +543,8 @@ { "name": "memberId", "in": "path", - "required": true, "description": "Identifier for member this stateDigest applies to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -555,27 +552,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Acks.StateDigest" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Acks.StateDigest" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -597,8 +594,8 @@ { "name": "memberId", "in": "path", - "required": true, "description": "ID of CCF member who this recovery share belongs to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -612,14 +609,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -634,6 +631,9 @@ "post": { "operationId": "Shares_Submit", "description": "Provide a recovery share for the purpose of completing a service recovery.", + "consumes": [ + "application/cose" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -641,8 +641,8 @@ { "name": "memberId", "in": "path", - "required": true, "description": "Identifier for member this recovery state applies to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" }, @@ -653,33 +653,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Recovery.RecoveryResponse" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/Recovery.RecoveryResponse" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cose" - ], "x-ms-examples": { "Shares_Submit": { "$ref": "./examples/Shares_Submit.json" @@ -691,6 +688,10 @@ "get": { "operationId": "ServiceState_GetConstitution", "description": "Retrieve the constitution which controls governance changes on this service.", + "produces": [ + "text/javascript", + "application/json" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -699,34 +700,30 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.ConstitutionResponse" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.ConstitutionResponse" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "produces": [ - "text/javascript", - "application/json" - ], "x-ms-examples": { "ServiceState_GetConstitution": { "$ref": "./examples/ServiceState_GetConstitution.json" @@ -746,27 +743,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.ServiceInfo" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.ServiceInfo" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -789,27 +786,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.JsApp" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.JsApp" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -832,27 +829,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.JoinPolicies" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.JoinPolicies" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -875,27 +872,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.JwkInfo" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.JwkInfo" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -918,59 +915,56 @@ "responses": { "200": { "description": "The request has succeeded.", - "headers": { - "x-ms-ccf-transaction-id": { - "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", - "type": "string", - "pattern": "^[0-9]+\\.[0-9]+$" - } - }, "schema": { "type": "object", + "description": "Paged collection of Member items", "properties": { "value": { "type": "array", + "description": "The Member items on this page", "items": { "$ref": "#/definitions/ServiceState.Member" }, - "x-ms-identifiers": [], - "description": "The Member items on this page", - "x-typespec-name": "ServiceState.Member[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of Member items", "required": [ "value" - ], - "x-typespec-name": "Azure.Core.Foundations.CustomPage" + ] + }, + "headers": { + "x-ms-ccf-transaction-id": { + "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", + "type": "string", + "pattern": "^[0-9]+\\.[0-9]+$" + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "ServiceState_ListMembers": { "$ref": "./examples/ServiceState_ListMembers.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -985,8 +979,8 @@ { "name": "memberId", "in": "path", - "required": true, "description": "ID of CCF member who this object refers to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -994,27 +988,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.Member" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.Member" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -1037,59 +1031,56 @@ "responses": { "200": { "description": "The request has succeeded.", - "headers": { - "x-ms-ccf-transaction-id": { - "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", - "type": "string", - "pattern": "^[0-9]+\\.[0-9]+$" - } - }, "schema": { "type": "object", + "description": "Paged collection of Node items", "properties": { "value": { "type": "array", + "description": "The Node items on this page", "items": { "$ref": "#/definitions/ServiceState.Node" }, - "x-ms-identifiers": [], - "description": "The Node items on this page", - "x-typespec-name": "ServiceState.Node[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of Node items", "required": [ "value" - ], - "x-typespec-name": "Azure.Core.Foundations.CustomPage" + ] + }, + "headers": { + "x-ms-ccf-transaction-id": { + "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", + "type": "string", + "pattern": "^[0-9]+\\.[0-9]+$" + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "ServiceState_ListNodes": { "$ref": "./examples/ServiceState_ListNodes.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -1104,8 +1095,8 @@ { "name": "nodeId", "in": "path", - "required": true, "description": "ID of CCF node who this object refers to.", + "required": true, "type": "string", "pattern": "^[a-f0-9]{64}$" } @@ -1113,27 +1104,27 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ServiceState.Node" + }, "headers": { "x-ms-ccf-transaction-id": { "description": "Identifier for transaction this response was read from. The service state may be altered by other write requests. Reads at the same transactionId describe a consistent single point in the service history.", "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } - }, - "schema": { - "$ref": "#/definitions/ServiceState.Node" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -1155,8 +1146,8 @@ { "name": "transactionId", "in": "path", - "required": true, "description": "Identifier of the requested transaction.", + "required": true, "type": "string", "pattern": "^[0-9]+\\.[0-9]+$" } @@ -1170,14 +1161,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -1206,14 +1197,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -1228,6 +1219,7 @@ "definitions": { "Acks.StateDigest": { "type": "object", + "description": "A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the service.", "properties": { "digest": { "type": "string", @@ -1235,13 +1227,13 @@ "pattern": "^[a-f0-9]{64}$" } }, - "description": "A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the service.", "required": [ "digest" ] }, "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -1257,19 +1249,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -1277,19 +1267,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -1299,11 +1290,11 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "Proposals.Action": { "type": "object", + "description": "A single step in a proposed change to the service.", "properties": { "name": { "type": "string", @@ -1313,26 +1304,26 @@ "description": "Arguments to modify the behavior of this action. The schema is determined by the action implementation, and should be validated by a `validate` call in the constitution." } }, - "description": "A single step in a proposed change to the service.", "required": [ "name" ] }, "Proposals.Ballot": { "type": "object", + "description": "The source script of an executable vote from a member, regarding a proposed change to the service.", "properties": { "script": { "type": "string", "description": "The script to execute, returning the voter's support of this proposal." } }, - "description": "The source script of an executable vote from a member, regarding a proposed change to the service.", "required": [ "script" ] }, "Proposals.FailureInfo": { "type": "object", + "description": "Description of why governance execution failed.", "properties": { "reason": { "type": "string", @@ -1343,20 +1334,20 @@ "description": "Call stack showing where failure occurred, if available." } }, - "description": "Description of why governance execution failed.", "required": [ "reason" ] }, "Proposals.MemberVotes": { "type": "object", + "description": "Each key is a memberId, and the corresponding value is the result of their ballot.", "additionalProperties": { "type": "boolean" - }, - "description": "Each key is a memberId, and the corresponding value is the result of their ballot." + } }, "Proposals.Proposal": { "type": "object", + "description": "Description of a proposed change to the service.", "properties": { "proposalId": { "$ref": "#/definitions/proposalId", @@ -1387,7 +1378,6 @@ "description": "If proposalState is Failure, then this will describe why the proposal failed." } }, - "description": "Description of a proposed change to the service.", "required": [ "proposalId", "proposerId", @@ -1397,18 +1387,17 @@ }, "Proposals.ProposalActions": { "type": "object", + "description": "The actions contained in a proposal, describing the proposal's changes.", "properties": { "actions": { "type": "array", + "description": "A list of actions to apply. Each action is considered, in order, for both proposal and execution of the proposal. All actions are validated and, if the proposal is accepted, applied atomically.", "items": { "$ref": "#/definitions/Proposals.Action" }, - "x-ms-identifiers": [], - "description": "A list of actions to apply. Each action is considered, in order, for both proposal and execution of the proposal. All actions are validated and, if the proposal is accepted, applied atomically.", - "x-typespec-name": "Proposals.Action[]" + "x-ms-identifiers": [] } }, - "description": "The actions contained in a proposal, describing the proposal's changes.", "required": [ "actions" ] @@ -1463,13 +1452,14 @@ }, "Proposals.VoteFailures": { "type": "object", + "description": "Each key is a memberId, and the corresponding value explains why execution of their ballot failed.", "additionalProperties": { "$ref": "#/definitions/Proposals.FailureInfo" - }, - "description": "Each key is a memberId, and the corresponding value explains why execution of their ballot failed." + } }, "Recovery.EncryptedRecoveryShare": { "type": "object", + "description": "A share of a recovery key, granted for a specific recovery member, and encrypted with that member's share-encryption key. This is safe to share in the ledger or amongst untrusted callers, as only the intended member will be able to decrypt and access the secret content.", "properties": { "encryptedShare": { "type": "string", @@ -1477,18 +1467,18 @@ "description": "Base-64 encoding of a member's encrypted share." } }, - "description": "A share of a recovery key, granted for a specific recovery member, and encrypted with that member's share-encryption key. This is safe to share in the ledger or amongst untrusted callers, as only the intended member will be able to decrypt and access the secret content.", "required": [ "encryptedShare" ] }, "Recovery.Member": { "type": "object", - "properties": {}, - "description": "Recovery-specific details for a given member." + "description": "Recovery-specific details for a given member.", + "properties": {} }, "Recovery.RecoveryResponse": { "type": "object", + "description": "Response to a submitted recovery share.", "properties": { "message": { "type": "string", @@ -1503,7 +1493,6 @@ "description": "Count of how many member shares are required to initiate the end-of-recovery procedure." } }, - "description": "Response to a submitted recovery share.", "required": [ "message", "submittedCount", @@ -1512,6 +1501,7 @@ }, "Recovery.RecoveryShare": { "type": "object", + "description": "Container for a member's raw recovery share. This should be carefully guarded, and only submitted to a trusted service over a secure channel, for the purposes of recovery.", "properties": { "share": { "type": "string", @@ -1519,20 +1509,19 @@ "description": "Base-64 encoding of a member's raw recovery share (unencrypted)." } }, - "description": "Container for a member's raw recovery share. This should be carefully guarded, and only submitted to a trusted service over a secure channel, for the purposes of recovery.", "required": [ "share" ] }, "ServiceState.ConstitutionResponse": { "type": "object", + "description": "Constitution used to make governance decisions on the service. All governance changes are presented as proposals which must be validated, approved, and applied by the code in this constitution.", "properties": { "constitution": { "type": "string", "description": "Javascript source code of constitution." } }, - "description": "Constitution used to make governance decisions on the service. All governance changes are presented as proposals which must be validated, approved, and applied by the code in this constitution.", "required": [ "constitution" ] @@ -1569,6 +1558,7 @@ }, "ServiceState.JoinPolicies": { "type": "object", + "description": "Collection of all policies which determine currently acceptable nodes, across multiple platforms.", "properties": { "sgx": { "$ref": "#/definitions/ServiceState.JoinPolicy", @@ -1579,7 +1569,6 @@ "description": "Policy applied to nodes running in AMD SEV-SNP containers." } }, - "description": "Collection of all policies which determine currently acceptable nodes, across multiple platforms.", "required": [ "sgx", "snp" @@ -1587,41 +1576,40 @@ }, "ServiceState.JoinPolicy": { "type": "object", + "description": "Describes what a joining node must present, in order to join the service.", "properties": { "measurements": { "type": "array", + "description": "Code measurements of acceptable enclaves.", "items": { "type": "string", "format": "byte" - }, - "description": "Code measurements of acceptable enclaves.", - "x-typespec-name": "bytes[]" + } } }, - "description": "Describes what a joining node must present, in order to join the service.", "required": [ "measurements" ] }, "ServiceState.JsApp": { "type": "object", + "description": "Describes the currently installed JavaScript application.", "properties": { "endpoints": { "type": "object", + "description": "The collection of endpoints exposed by the application. Keyed by path.", "additionalProperties": { "$ref": "#/definitions/ServiceState.JsOperations" - }, - "description": "The collection of endpoints exposed by the application. Keyed by path.", - "x-typespec-name": "Record" + } } }, - "description": "Describes the currently installed JavaScript application.", "required": [ "endpoints" ] }, "ServiceState.JsEndpointInfo": { "type": "object", + "description": "Describes an endpoint implemented by a Javascript handler.", "properties": { "jsModule": { "type": "string", @@ -1637,11 +1625,10 @@ }, "authnPolicies": { "type": "array", + "description": "The authentication policies which restrict access to this endpoint", "items": { "type": "string" - }, - "description": "The authentication policies which restrict access to this endpoint", - "x-typespec-name": "string[]" + } }, "mode": { "$ref": "#/definitions/ServiceState.JsExecMode", @@ -1649,12 +1636,10 @@ }, "openApi": { "type": "object", - "additionalProperties": true, "description": "An OpenAPI Operation object (https://swagger.io/specification/#operation-object) describing this operation. This is merged into the auto-generated OpenAPI to describe the current application's API.", - "x-typespec-name": "Record" + "additionalProperties": true } }, - "description": "Describes an endpoint implemented by a Javascript handler.", "required": [ "jsModule", "jsFunction", @@ -1696,32 +1681,30 @@ }, "ServiceState.JsOperations": { "type": "object", + "description": "The collection of operations available on each path. Keyed by HTTP method.", "additionalProperties": { "$ref": "#/definitions/ServiceState.JsEndpointInfo" - }, - "description": "The collection of operations available on each path. Keyed by HTTP method." + } }, "ServiceState.JwkInfo": { "type": "object", + "description": "Describes what Javascript Web Tokens (JWTs) are accepted by the service, and how they will be validated.", "properties": { "issuers": { "type": "object", + "description": "Collection of JWT issuers. Keyed by issuer ID.", "additionalProperties": { "$ref": "#/definitions/ServiceState.JwtIssuer" - }, - "description": "Collection of JWT issuers. Keyed by issuer ID.", - "x-typespec-name": "Record" + } }, "caCertBundles": { "type": "object", + "description": "Collection of CAs used to authenticate connections with issuers. Keyed by governance-controlled bundle names.", "additionalProperties": { "$ref": "#/definitions/ServiceState.caCertBundle" - }, - "description": "Collection of CAs used to authenticate connections with issuers. Keyed by governance-controlled bundle names.", - "x-typespec-name": "Record" + } } }, - "description": "Describes what Javascript Web Tokens (JWTs) are accepted by the service, and how they will be validated.", "required": [ "issuers", "caCertBundles" @@ -1729,6 +1712,7 @@ }, "ServiceState.JwtIssuer": { "type": "object", + "description": "Description of a JWT issuer or identity provider that the current service will trust tokens from.", "properties": { "keyFilter": { "$ref": "#/definitions/ServiceState.JwtIssuerKeyFilter", @@ -1736,11 +1720,10 @@ }, "keyPolicy": { "type": "object", + "description": "Collection of claims which must be present in SGX attestation to permit updates from this issuer.", "additionalProperties": { "type": "string" - }, - "description": "Collection of claims which must be present in SGX attestation to permit updates from this issuer.", - "x-typespec-name": "Record" + } }, "autoRefresh": { "type": "boolean", @@ -1751,7 +1734,6 @@ "description": "Name of bundle used to authenticate issuer when auto-refreshing." } }, - "description": "Description of a JWT issuer or identity provider that the current service will trust tokens from.", "required": [ "keyFilter", "autoRefresh" @@ -1783,6 +1765,7 @@ }, "ServiceState.Member": { "type": "object", + "description": "Information on individual members within a consortium.", "properties": { "memberId": { "$ref": "#/definitions/memberId", @@ -1800,7 +1783,6 @@ "description": "x509 certificate used as this member's identity." } }, - "description": "Information on individual members within a consortium.", "required": [ "memberId", "status", @@ -1833,6 +1815,7 @@ }, "ServiceState.NetworkInterface": { "type": "object", + "description": "Details of how to contact a CCF node. Each node may listen on multiple interfaces, for different kinds of traffic.", "properties": { "publishedAddress": { "type": "string", @@ -1843,7 +1826,6 @@ "description": "The application layer protocol which the node expects on this interface. Currently supports \"http1\" and \"http2\", more protocols may be added in future." } }, - "description": "Details of how to contact a CCF node. Each node may listen on multiple interfaces, for different kinds of traffic.", "required": [ "publishedAddress", "protocol" @@ -1851,6 +1833,7 @@ }, "ServiceState.Node": { "type": "object", + "description": "Information on individual nodes within a service.", "properties": { "nodeId": { "$ref": "#/definitions/nodeId", @@ -1877,14 +1860,12 @@ }, "rpcInterfaces": { "type": "object", + "description": "A collection of interfaces by which this node may be contacted. Some may be limited to private networks, and others may be DNS names or internet-public network addresses. The keys are arbitrary strings determined by the node operator.", "additionalProperties": { "$ref": "#/definitions/ServiceState.NetworkInterface" - }, - "description": "A collection of interfaces by which this node may be contacted. Some may be limited to private networks, and others may be DNS names or internet-public network addresses. The keys are arbitrary strings determined by the node operator.", - "x-typespec-name": "Record" + } } }, - "description": "Information on individual nodes within a service.", "required": [ "nodeId", "status", @@ -1926,13 +1907,13 @@ }, "ServiceState.QuoteInfo": { "type": "object", + "description": "Common type for attestation information, describing the cryptographically-endorsed claim of what code is executing, and what platform it is executing on. Derived types contain platform-specific details.", "properties": { "format": { "type": "string", "description": "Discriminator property for QuoteInfo." } }, - "description": "Common type for attestation information, describing the cryptographically-endorsed claim of what code is executing, and what platform it is executing on. Derived types contain platform-specific details.", "discriminator": "format", "required": [ "format" @@ -1940,6 +1921,7 @@ }, "ServiceState.ServiceInfo": { "type": "object", + "description": "General information about the current service.", "properties": { "status": { "$ref": "#/definitions/ServiceState.ServiceStatus", @@ -1966,6 +1948,7 @@ }, "configuration": { "type": "object", + "description": "Lists governance-controlled configuration parameters of this service, which will be used by core framework code.", "properties": { "maximumNodeCertificateValidityDays": { "$ref": "#/definitions/safeuint" @@ -1974,15 +1957,12 @@ "$ref": "#/definitions/safeuint" } }, - "description": "Lists governance-controlled configuration parameters of this service, which will be used by core framework code.", "required": [ "maximumNodeCertificateValidityDays", "recentCoseProposalsWindowSize" - ], - "x-typespec-name": "ServiceState.(anonymous model)" + ] } }, - "description": "General information about the current service.", "required": [ "status", "certificate", @@ -2029,6 +2009,7 @@ }, "ServiceState.SgxQuoteInfo": { "type": "object", + "description": "Attestation information for Intel SGX enclaves.", "properties": { "quote": { "type": "string", @@ -2041,7 +2022,6 @@ "description": "Base-64 encoded SGX endorsements." } }, - "description": "Attestation information for Intel SGX enclaves.", "required": [ "quote", "endorsements" @@ -2055,36 +2035,33 @@ }, "ServiceState.SnpJoinPolicy": { "type": "object", + "description": "Join policy fields specific to nodes running on AMD SEV-SNP hardware.", "properties": { "measurements": { "type": "array", + "description": "Code measurements of acceptable enclaves.", "items": { "type": "string", "format": "byte" - }, - "description": "Code measurements of acceptable enclaves.", - "x-typespec-name": "bytes[]" + } }, "hostData": { "type": "object", - "additionalProperties": { - "type": "string", - "format": "byte" - }, "description": "Collection of acceptable host data values.", - "x-typespec-name": "Record" + "additionalProperties": { + "format": "byte", + "type": "string" + } }, "uvmEndorsements": { "type": "object", - "additionalProperties": { - "type": "string", - "format": "byte" - }, "description": "Collection of acceptable UVM endorsements.", - "x-typespec-name": "Record" + "additionalProperties": { + "format": "byte", + "type": "string" + } } }, - "description": "Join policy fields specific to nodes running on AMD SEV-SNP hardware.", "required": [ "measurements", "hostData", @@ -2093,6 +2070,7 @@ }, "ServiceState.SnpQuoteInfo": { "type": "object", + "description": "Attestation information for AMD SEV-SNP containers.", "properties": { "uvmEndorsements": { "type": "string", @@ -2105,7 +2083,6 @@ "description": "Base-64 encoded SNP TCB endorsements." } }, - "description": "Attestation information for AMD SEV-SNP containers.", "required": [ "uvmEndorsements", "endorsedTcb" @@ -2127,6 +2104,7 @@ }, "Transactions.CommittedTransaction": { "type": "object", + "description": "Description of latest committed transaction.", "properties": { "transactionId": { "$ref": "#/definitions/transactionId", @@ -2137,7 +2115,6 @@ "description": "Status of this transaction." } }, - "description": "Description of latest committed transaction.", "required": [ "transactionId", "status" @@ -2145,26 +2122,26 @@ }, "Transactions.NamedTransaction": { "type": "object", + "description": "Description of a named transaction's current state.", "properties": { "status": { "$ref": "#/definitions/Transactions.TransactionStatus", "description": "Status of this transaction." } }, - "description": "Description of a named transaction's current state.", "required": [ "status" ] }, "Transactions.Transaction": { "type": "object", + "description": "Common transaction information.", "properties": { "status": { "$ref": "#/definitions/Transactions.TransactionStatus", "description": "Status of this transaction." } }, - "description": "Common transaction information.", "required": [ "status" ] @@ -2251,18 +2228,18 @@ "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" }, "CoseSignature.body": { "name": "body", "in": "body", - "required": true, "description": "A raw CoseSign1 signature. See CCF docs for required headers and body schema: https://microsoft.github.io/CCF/main/use_apps/issue_commands.html#cose-schemas", + "required": true, "schema": { "type": "string", "format": "binary" diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/consumption.json index ad4b4601e2d5..e162b97c6358 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/consumption.json @@ -1905,6 +1905,29 @@ } } }, + "SavingsPlan": { + "type": "object", + "description": "The properties of the SavingsPlan.", + "properties": { + "term": { + "description": "SavingsPlan term", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "SavingsPlan Market Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "effectivePrice": { + "description": "SavingsPlan Effective Price", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, "UsageDetail": { "type": "object", "discriminator": "kind", @@ -4612,6 +4635,11 @@ "description": "Offer Id", "type": "string", "readOnly": true + }, + "savingsPlan": { + "description": "SavingsPlan Details", + "$ref": "#/definitions/SavingsPlan", + "readOnly": true } } }, diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/examples/PriceSheet.json index 39a2df866a19..8e83bb24e478 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/examples/PriceSheet.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2022-09-01/examples/PriceSheet.json @@ -20,7 +20,12 @@ "partNumber": "XX-11110", "unitPrice": 0.00328, "currencyCode": "EUR", - "offerId": "OfferId 1" + "offerId": "OfferId 1", + "savingsPlan": { + "term": "P3Y", + "effectivePrice": 0.002, + "marketPrice": 0.00328 + } } ] } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/consumption.json index 85e97f868e47..76aa46f2c1c4 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/consumption.json @@ -1911,6 +1911,29 @@ } } }, + "SavingsPlan": { + "description": "The properties of the SavingsPlan.", + "type": "object", + "properties": { + "term": { + "description": "SavingsPlan term", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "SavingsPlan Market Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "effectivePrice": { + "description": "SavingsPlan Effective Price", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, "UsageDetail": { "type": "object", "discriminator": "kind", @@ -4618,6 +4641,11 @@ "description": "Offer Id", "type": "string", "readOnly": true + }, + "savingsPlan": { + "description": "SavingsPlan Details", + "$ref": "#/definitions/SavingsPlan", + "readOnly": true } } }, diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/examples/PriceSheet.json index 6605296044fa..0bcc54480709 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/examples/PriceSheet.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-03-01/examples/PriceSheet.json @@ -20,7 +20,12 @@ "partNumber": "XX-11110", "unitPrice": 0.00328, "currencyCode": "EUR", - "offerId": "OfferId 1" + "offerId": "OfferId 1", + "savingsPlan": { + "term": "P3Y", + "effectivePrice": 0.002, + "marketPrice": 0.00328 + } } ] } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/consumption.json index 03376d88ddc5..05cdfdfac91f 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/consumption.json @@ -1914,6 +1914,29 @@ } } }, + "SavingsPlan": { + "type": "object", + "description": "The properties of the SavingsPlan.", + "properties": { + "term": { + "description": "SavingsPlan term", + "type": "string", + "readOnly": true + }, + "marketPrice": { + "description": "SavingsPlan Market Price", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "effectivePrice": { + "description": "SavingsPlan Effective Price", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, "UsageDetail": { "type": "object", "discriminator": "kind", @@ -4621,6 +4644,11 @@ "description": "Offer Id", "type": "string", "readOnly": true + }, + "savingsPlan": { + "description": "SavingsPlan Details", + "$ref": "#/definitions/SavingsPlan", + "readOnly": true } } }, diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/examples/PriceSheet.json index 73214f0baa23..bbe08a459cfb 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/examples/PriceSheet.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2023-05-01/examples/PriceSheet.json @@ -20,7 +20,12 @@ "partNumber": "XX-11110", "unitPrice": 0.00328, "currencyCode": "EUR", - "offerId": "OfferId 1" + "offerId": "OfferId 1", + "savingsPlan": { + "term": "P3Y", + "effectivePrice": 0.002, + "marketPrice": 0.00328 + } } ] } diff --git a/specification/containerservice/Fleet.Management/fleet.tsp b/specification/containerservice/Fleet.Management/fleet.tsp index 6b7e8d6ad2af..1b9fb765e6a4 100644 --- a/specification/containerservice/Fleet.Management/fleet.tsp +++ b/specification/containerservice/Fleet.Management/fleet.tsp @@ -29,6 +29,7 @@ model Fleet is TrackedResource { @segment("fleets") @visibility("create", "read") name: string; + ...EntityTag; } diff --git a/specification/containerservice/Fleet.Management/fleetmember.tsp b/specification/containerservice/Fleet.Management/fleetmember.tsp index 94793fef2fce..d741cda366b6 100644 --- a/specification/containerservice/Fleet.Management/fleetmember.tsp +++ b/specification/containerservice/Fleet.Management/fleetmember.tsp @@ -24,6 +24,7 @@ model FleetMember is ProxyResource { @segment("members") @visibility("create", "read") name: string; + ...EntityTag; } diff --git a/specification/containerservice/Fleet.Management/helpers.tsp b/specification/containerservice/Fleet.Management/helpers.tsp index 7b35d2cbe420..6c42eab412bf 100644 --- a/specification/containerservice/Fleet.Management/helpers.tsp +++ b/specification/containerservice/Fleet.Management/helpers.tsp @@ -42,7 +42,7 @@ op ArmResourceNoRequestBodyActionSync< TResponse extends TypeSpec.Reflection.Model, TBaseParameters = Azure.ResourceManager.Foundations.BaseParameters >( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; #suppress "@azure-tools/typespec-azure-core/documentation-required" "this is a template" @@ -61,7 +61,7 @@ op ArmResourceNoRequestBodyActionAsync< TResponse extends TypeSpec.Reflection.Model, TBaseParameters = Azure.ResourceManager.Foundations.BaseParameters >( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse | ArmAcceptedResponseWithLocationHeader | ErrorResponse; #suppress "@azure-tools/cadl-azure-resource-manager/arm-resource-operation-outside-interface" "this is a template" @@ -78,7 +78,7 @@ op FleetCustomPatchSync< @doc("The resource properties to be updated.") @body - parameters?: TPatchModel //prevents api breaking change. properties -> parameters + parameters?: TPatchModel, //prevents api breaking change. properties -> parameters ): ArmResponse | ErrorResponse; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation-outside-interface" "this is a template" @@ -101,7 +101,7 @@ op FleetArmResourceCreateOrUpdateAsync< @doc("Resource create parameters.") @body - parameters: TResource //prevent api breaking change. resource -> parameters + parameters: TResource, //prevent api breaking change. resource -> parameters ): ArmResponse | ArmCreatedResponse | ErrorResponse; // this is a copy of ArmResourceDeleteAsync that adds the location header to comply with arm linter. diff --git a/specification/containerservice/Fleet.Management/updaterun.tsp b/specification/containerservice/Fleet.Management/updaterun.tsp index 343e6c45a66b..ad2f63b4f497 100644 --- a/specification/containerservice/Fleet.Management/updaterun.tsp +++ b/specification/containerservice/Fleet.Management/updaterun.tsp @@ -30,6 +30,7 @@ model UpdateRun is ProxyResource { @path @visibility("create", "read") name: string; + ...EntityTag; } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json index c3bc21e4e854..0c8228d8dd2e 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/preview/2022-09-02-preview/fleets.json @@ -52,10 +52,10 @@ "paths": { "/providers/Microsoft.ContainerService/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -76,22 +76,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "List the available operations.": { "$ref": "./examples/Operation_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/fleets": { "get": { + "operationId": "Fleets_ListBySubscription", "tags": [ "Fleets" ], - "operationId": "Fleets_ListBySubscription", "description": "Lists fleets in the specified subscription.", "parameters": [ { @@ -115,22 +115,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the Fleet resources in a subscription.": { "$ref": "./examples/Fleets_ListBySub.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets": { "get": { + "operationId": "Fleets_ListByResourceGroup", "tags": [ "Fleets" ], - "operationId": "Fleets_ListByResourceGroup", "description": "Lists fleets in the specified subscription and resource group.", "parameters": [ { @@ -157,22 +157,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the Fleet resources in a resource group.": { "$ref": "./examples/Fleets_ListByResourceGroup.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}": { "get": { + "operationId": "Fleets_Get", "tags": [ "Fleets" ], - "operationId": "Fleets_Get", "description": "Gets a Fleet.", "parameters": [ { @@ -187,12 +187,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -216,10 +216,10 @@ } }, "put": { + "operationId": "Fleets_CreateOrUpdate", "tags": [ "Fleets" ], - "operationId": "Fleets_CreateOrUpdate", "description": "Creates or updates a Fleet.", "parameters": [ { @@ -234,34 +234,34 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "required": false, "description": "The request should only proceed if no entity matches this string.", - "x-ms-client-name": "ifNoneMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Fleet" } @@ -276,15 +276,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Fleet" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Fleet" } }, "default": { @@ -305,10 +305,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "Fleets_Update", "tags": [ "Fleets" ], - "operationId": "Fleets_Update", "description": "Update a Fleet", "parameters": [ { @@ -323,26 +323,26 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/FleetPatch" } @@ -369,10 +369,10 @@ } }, "delete": { + "operationId": "Fleets_Delete", "tags": [ "Fleets" ], - "operationId": "Fleets_Delete", "description": "Delete a Fleet", "parameters": [ { @@ -387,20 +387,20 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -411,13 +411,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -444,10 +444,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/listCredentials": { "post": { + "operationId": "Fleets_ListCredentials", "tags": [ "Fleets" ], - "operationId": "Fleets_ListCredentials", "description": "Lists the user credentials of a Fleet.", "parameters": [ { @@ -462,12 +462,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -493,10 +493,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members": { "get": { + "operationId": "FleetMembers_ListByFleet", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_ListByFleet", "description": "List FleetMember resources by Fleet", "parameters": [ { @@ -511,12 +511,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -533,22 +533,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the members of a Fleet.": { "$ref": "./examples/FleetMembers_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members/{fleetMemberName}": { "get": { + "operationId": "FleetMembers_Get", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Get", "description": "Get a FleetMember", "parameters": [ { @@ -563,22 +563,22 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -602,10 +602,10 @@ } }, "put": { + "operationId": "FleetMembers_Create", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Create", "description": "Create a FleetMember", "parameters": [ { @@ -620,44 +620,44 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "required": false, "description": "The request should only proceed if no entity matches this string.", - "x-ms-client-name": "ifNoneMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/FleetMember" } @@ -672,15 +672,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FleetMember" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/FleetMember" } }, "default": { @@ -701,10 +701,10 @@ "x-ms-long-running-operation": true }, "delete": { + "operationId": "FleetMembers_Delete", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Delete", "description": "Delete a FleetMember", "parameters": [ { @@ -719,30 +719,30 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -753,13 +753,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -788,8 +788,8 @@ "definitions": { "ClusterResourceId": { "type": "string", - "description": "A type definition that refers the id to an ARM resource.", "format": "arm-id", + "description": "A type definition that refers the id to an ARM resource.", "x-ms-arm-id-details": { "allowedResources": [ { @@ -800,6 +800,7 @@ }, "Fleet": { "type": "object", + "description": "The Fleet resource.", "properties": { "properties": { "$ref": "#/definitions/FleetProperties", @@ -816,7 +817,6 @@ "readOnly": true } }, - "description": "The Fleet resource.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -825,6 +825,7 @@ }, "FleetCredentialResult": { "type": "object", + "description": "One credential result item.", "properties": { "name": { "type": "string", @@ -837,36 +838,35 @@ "description": "Base64-encoded Kubernetes configuration file.", "readOnly": true } - }, - "description": "One credential result item." + } }, "FleetCredentialResults": { "type": "object", + "description": "The Credential results response.", "properties": { "kubeconfigs": { "type": "array", + "description": "Array of base64-encoded Kubernetes configuration files.", "items": { "$ref": "#/definitions/FleetCredentialResult" }, + "readOnly": true, "x-ms-identifiers": [ "name" - ], - "description": "Array of base64-encoded Kubernetes configuration files.", - "x-typespec-name": "FleetCredentialResult[]", - "readOnly": true + ] } - }, - "description": "The Credential results response." + } }, "FleetHubProfile": { "type": "object", + "description": "The FleetHubProfile configures the fleet hub.", "properties": { "dnsPrefix": { "type": "string", "description": "DNS prefix used to create the FQDN for the Fleet hub.", - "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$", "minLength": 1, "maxLength": 54, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$", "x-ms-mutability": [ "read", "create" @@ -882,34 +882,32 @@ "description": "The Kubernetes version of the Fleet hub.", "readOnly": true } - }, - "description": "The FleetHubProfile configures the fleet hub." + } }, "FleetListResult": { "type": "object", + "description": "The response of a Fleet list operation.", "properties": { "value": { "type": "array", + "description": "The Fleet items on this page", "items": { "$ref": "#/definitions/Fleet" - }, - "description": "The Fleet items on this page", - "x-typespec-name": "Fleet[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Fleet list operation.", "required": [ "value" ] }, "FleetMember": { "type": "object", + "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "properties": { "properties": { "$ref": "#/definitions/FleetMemberProperties", @@ -926,7 +924,6 @@ "readOnly": true } }, - "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -935,29 +932,28 @@ }, "FleetMemberListResult": { "type": "object", + "description": "The response of a FleetMember list operation.", "properties": { "value": { "type": "array", + "description": "The FleetMember items on this page", "items": { "$ref": "#/definitions/FleetMember" - }, - "description": "The FleetMember items on this page", - "x-typespec-name": "FleetMember[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a FleetMember list operation.", "required": [ "value" ] }, "FleetMemberProperties": { "type": "object", + "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "properties": { "clusterResourceId": { "$ref": "#/definitions/ClusterResourceId", @@ -973,7 +969,6 @@ "readOnly": true } }, - "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "required": [ "clusterResourceId" ] @@ -1025,20 +1020,20 @@ }, "FleetPatch": { "type": "object", + "description": "Properties of a Fleet that can be patched.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } } - }, - "description": "Properties of a Fleet that can be patched." + } }, "FleetProperties": { "type": "object", + "description": "Fleet properties.", "properties": { "provisioningState": { "$ref": "#/definitions/FleetProvisioningState", @@ -1049,8 +1044,7 @@ "$ref": "#/definitions/FleetHubProfile", "description": "The FleetHubProfile configures the Fleet's hub." } - }, - "description": "Fleet properties." + } }, "FleetProvisioningState": { "type": "string", 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 68413576709a..415fdbc2001e 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 @@ -55,10 +55,10 @@ "paths": { "/providers/Microsoft.ContainerService/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -79,22 +79,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "List the operations for the provider.": { "$ref": "./examples/Operations_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/fleets": { "get": { + "operationId": "Fleets_ListBySubscription", "tags": [ "Fleets" ], - "operationId": "Fleets_ListBySubscription", "description": "Lists fleets in the specified subscription.", "parameters": [ { @@ -118,22 +118,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the Fleet resources in a subscription.": { "$ref": "./examples/Fleets_ListBySub.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets": { "get": { + "operationId": "Fleets_ListByResourceGroup", "tags": [ "Fleets" ], - "operationId": "Fleets_ListByResourceGroup", "description": "Lists fleets in the specified subscription and resource group.", "parameters": [ { @@ -160,22 +160,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the Fleet resources in a resource group.": { "$ref": "./examples/Fleets_ListByResourceGroup.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}": { "get": { + "operationId": "Fleets_Get", "tags": [ "Fleets" ], - "operationId": "Fleets_Get", "description": "Gets a Fleet.", "parameters": [ { @@ -190,12 +190,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -219,10 +219,10 @@ } }, "put": { + "operationId": "Fleets_CreateOrUpdate", "tags": [ "Fleets" ], - "operationId": "Fleets_CreateOrUpdate", "description": "Creates or updates a Fleet.", "parameters": [ { @@ -237,34 +237,34 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "required": false, "description": "The request should only proceed if no entity matches this string.", - "x-ms-client-name": "ifNoneMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Fleet" } @@ -279,15 +279,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Fleet" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Fleet" } }, "default": { @@ -308,10 +308,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "Fleets_Update", "tags": [ "Fleets" ], - "operationId": "Fleets_Update", "description": "Update a Fleet", "parameters": [ { @@ -326,26 +326,26 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/FleetPatch" } @@ -372,10 +372,10 @@ } }, "delete": { + "operationId": "Fleets_Delete", "tags": [ "Fleets" ], - "operationId": "Fleets_Delete", "description": "Delete a Fleet", "parameters": [ { @@ -390,20 +390,20 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -414,13 +414,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -447,10 +447,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/listCredentials": { "post": { + "operationId": "Fleets_ListCredentials", "tags": [ "Fleets" ], - "operationId": "Fleets_ListCredentials", "description": "Lists the user credentials of a Fleet.", "parameters": [ { @@ -465,12 +465,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -496,10 +496,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members": { "get": { + "operationId": "FleetMembers_ListByFleet", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_ListByFleet", "description": "List FleetMember resources by Fleet", "parameters": [ { @@ -514,12 +514,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -536,22 +536,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the members of a Fleet.": { "$ref": "./examples/FleetMembers_ListByFleet.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/members/{fleetMemberName}": { "get": { + "operationId": "FleetMembers_Get", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Get", "description": "Get a FleetMember", "parameters": [ { @@ -566,22 +566,22 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -605,10 +605,10 @@ } }, "put": { + "operationId": "FleetMembers_Create", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Create", "description": "Create a FleetMember", "parameters": [ { @@ -623,44 +623,44 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "required": false, "description": "The request should only proceed if no entity matches this string.", - "x-ms-client-name": "ifNoneMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/FleetMember" } @@ -675,15 +675,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/FleetMember" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/FleetMember" } }, "default": { @@ -704,10 +704,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "FleetMembers_Update", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Update", "description": "Update a FleetMember", "parameters": [ { @@ -722,36 +722,36 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/FleetMemberUpdate" } @@ -778,10 +778,10 @@ } }, "delete": { + "operationId": "FleetMembers_Delete", "tags": [ "FleetMembers" ], - "operationId": "FleetMembers_Delete", "description": "Delete a FleetMember", "parameters": [ { @@ -796,30 +796,30 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "fleetMemberName", "in": "path", - "required": true, "description": "The name of the Fleet member resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -830,13 +830,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -863,10 +863,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns": { "get": { + "operationId": "UpdateRuns_ListByFleet", "tags": [ "UpdateRuns" ], - "operationId": "UpdateRuns_ListByFleet", "description": "List UpdateRun resources by Fleet", "parameters": [ { @@ -881,12 +881,12 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -903,22 +903,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Lists the UpdateRun resources by fleet.": { "$ref": "./examples/UpdateRuns_ListByFleet.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}": { "get": { + "operationId": "UpdateRuns_Get", "tags": [ "UpdateRuns" ], - "operationId": "UpdateRuns_Get", "description": "Get a UpdateRun", "parameters": [ { @@ -933,22 +933,22 @@ { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "updateRunName", "in": "path", - "required": true, "description": "The name of the UpdateRun resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -972,10 +972,10 @@ } }, "put": { + "operationId": "UpdateRuns_CreateOrUpdate", "tags": [ "UpdateRuns" ], - "operationId": "UpdateRuns_CreateOrUpdate", "description": "Create a UpdateRun", "parameters": [ { @@ -990,44 +990,44 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", - "required": false, "description": "The request should only proceed if no entity matches this string.", - "x-ms-client-name": "ifNoneMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "updateRunName", "in": "path", - "required": true, "description": "The name of the UpdateRun resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/UpdateRun" } @@ -1042,15 +1042,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/UpdateRun" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/UpdateRun" } }, "default": { @@ -1071,10 +1071,10 @@ "x-ms-long-running-operation": true }, "delete": { + "operationId": "UpdateRuns_Delete", "tags": [ "UpdateRuns" ], - "operationId": "UpdateRuns_Delete", "description": "Delete a UpdateRun", "parameters": [ { @@ -1089,30 +1089,30 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "updateRunName", "in": "path", - "required": true, "description": "The name of the UpdateRun resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -1123,13 +1123,13 @@ "description": "The request has been accepted for processing, but processing has not yet completed.", "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1156,10 +1156,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/start": { "post": { + "operationId": "UpdateRuns_Start", "tags": [ "UpdateRuns" ], - "operationId": "UpdateRuns_Start", "description": "Starts an UpdateRun.", "parameters": [ { @@ -1174,30 +1174,30 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "updateRunName", "in": "path", - "required": true, "description": "The name of the UpdateRun resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -1211,13 +1211,13 @@ "description": "The request has been accepted for processing, but processing has not yet completed.", "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1241,10 +1241,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/fleets/{fleetName}/updateRuns/{updateRunName}/stop": { "post": { + "operationId": "UpdateRuns_Stop", "tags": [ "UpdateRuns" ], - "operationId": "UpdateRuns_Stop", "description": "Stops an UpdateRun.", "parameters": [ { @@ -1259,30 +1259,30 @@ { "name": "If-Match", "in": "header", - "required": false, "description": "The request should only proceed if an entity matches this string.", - "x-ms-client-name": "ifMatch", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" }, { "name": "fleetName", "in": "path", - "required": true, "description": "The name of the Fleet resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 63 + "maxLength": 63, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, { "name": "updateRunName", "in": "path", - "required": true, "description": "The name of the UpdateRun resource.", + "required": true, "type": "string", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } ], "responses": { @@ -1296,13 +1296,13 @@ "description": "The request has been accepted for processing, but processing has not yet completed.", "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1328,8 +1328,8 @@ "definitions": { "ClusterResourceId": { "type": "string", - "description": "A type definition that refers the id to an ARM resource.", "format": "arm-id", + "description": "A type definition that refers the id to an ARM resource.", "x-ms-arm-id-details": { "allowedResources": [ { @@ -1340,6 +1340,7 @@ }, "Fleet": { "type": "object", + "description": "The Fleet resource.", "properties": { "properties": { "$ref": "#/definitions/FleetProperties", @@ -1356,7 +1357,6 @@ "readOnly": true } }, - "description": "The Fleet resource.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -1365,6 +1365,7 @@ }, "FleetCredentialResult": { "type": "object", + "description": "One credential result item.", "properties": { "name": { "type": "string", @@ -1377,36 +1378,35 @@ "description": "Base64-encoded Kubernetes configuration file.", "readOnly": true } - }, - "description": "One credential result item." + } }, "FleetCredentialResults": { "type": "object", + "description": "The Credential results response.", "properties": { "kubeconfigs": { "type": "array", + "description": "Array of base64-encoded Kubernetes configuration files.", "items": { "$ref": "#/definitions/FleetCredentialResult" }, + "readOnly": true, "x-ms-identifiers": [ "name" - ], - "description": "Array of base64-encoded Kubernetes configuration files.", - "x-typespec-name": "FleetCredentialResult[]", - "readOnly": true + ] } - }, - "description": "The Credential results response." + } }, "FleetHubProfile": { "type": "object", + "description": "The FleetHubProfile configures the fleet hub.", "properties": { "dnsPrefix": { "type": "string", "description": "DNS prefix used to create the FQDN for the Fleet hub.", - "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$", "minLength": 1, "maxLength": 54, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$", "x-ms-mutability": [ "read", "create" @@ -1422,34 +1422,32 @@ "description": "The Kubernetes version of the Fleet hub.", "readOnly": true } - }, - "description": "The FleetHubProfile configures the fleet hub." + } }, "FleetListResult": { "type": "object", + "description": "The response of a Fleet list operation.", "properties": { "value": { "type": "array", + "description": "The Fleet items on this page", "items": { "$ref": "#/definitions/Fleet" - }, - "description": "The Fleet items on this page", - "x-typespec-name": "Fleet[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Fleet list operation.", "required": [ "value" ] }, "FleetMember": { "type": "object", + "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "properties": { "properties": { "$ref": "#/definitions/FleetMemberProperties", @@ -1466,7 +1464,6 @@ "readOnly": true } }, - "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -1475,29 +1472,28 @@ }, "FleetMemberListResult": { "type": "object", + "description": "The response of a FleetMember list operation.", "properties": { "value": { "type": "array", + "description": "The FleetMember items on this page", "items": { "$ref": "#/definitions/FleetMember" - }, - "description": "The FleetMember items on this page", - "x-typespec-name": "FleetMember[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a FleetMember list operation.", "required": [ "value" ] }, "FleetMemberProperties": { "type": "object", + "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "properties": { "clusterResourceId": { "$ref": "#/definitions/ClusterResourceId", @@ -1510,9 +1506,9 @@ "group": { "type": "string", "description": "The group this member belongs to for multi-cluster update management.", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "provisioningState": { "$ref": "#/definitions/FleetMemberProvisioningState", @@ -1520,7 +1516,6 @@ "readOnly": true } }, - "description": "A member of the Fleet. It contains a reference to an existing Kubernetes cluster on Azure.", "required": [ "clusterResourceId" ] @@ -1572,43 +1567,43 @@ }, "FleetMemberUpdate": { "type": "object", + "description": "The type used for update operations of the FleetMember.", "properties": { "properties": { "$ref": "#/definitions/FleetMemberUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the FleetMember." + } }, "FleetMemberUpdateProperties": { "type": "object", + "description": "The updatable properties of the FleetMember.", "properties": { "group": { "type": "string", "description": "The group this member belongs to for multi-cluster update management.", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } - }, - "description": "The updatable properties of the FleetMember." + } }, "FleetPatch": { "type": "object", + "description": "Properties of a Fleet that can be patched.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } } - }, - "description": "Properties of a Fleet that can be patched." + } }, "FleetProperties": { "type": "object", + "description": "Fleet properties.", "properties": { "provisioningState": { "$ref": "#/definitions/FleetProvisioningState", @@ -1619,8 +1614,7 @@ "$ref": "#/definitions/FleetHubProfile", "description": "The FleetHubProfile configures the Fleet's hub." } - }, - "description": "Fleet properties." + } }, "FleetProvisioningState": { "type": "string", @@ -1672,19 +1666,20 @@ }, "ManagedClusterUpdate": { "type": "object", + "description": "The update to be applied to the ManagedClusters.", "properties": { "upgrade": { "$ref": "#/definitions/ManagedClusterUpgradeSpec", "description": "The upgrade to apply to the ManagedClusters." } }, - "description": "The update to be applied to the ManagedClusters.", "required": [ "upgrade" ] }, "ManagedClusterUpgradeSpec": { "type": "object", + "description": "The upgrade to apply to a ManagedCluster.", "properties": { "type": { "$ref": "#/definitions/ManagedClusterUpgradeType", @@ -1695,7 +1690,6 @@ "description": "The Kubernetes version to upgrade the member clusters to." } }, - "description": "The upgrade to apply to a ManagedCluster.", "required": [ "type" ] @@ -1726,6 +1720,7 @@ }, "MemberUpdateStatus": { "type": "object", + "description": "The status of a member update operation.", "properties": { "status": { "$ref": "#/definitions/UpdateStatus", @@ -1747,27 +1742,27 @@ "description": "The operation resource id of the latest attempt to perform the operation.", "readOnly": true } - }, - "description": "The status of a member update operation." + } }, "UpdateGroup": { "type": "object", + "description": "A group to be updated.", "properties": { "name": { "type": "string", "description": "The name of the Fleet member group to update. \nIt should match the name of an existing FleetMember group.\nA group can only appear once across all UpdateStages in the UpdateRun.", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" } }, - "description": "A group to be updated.", "required": [ "name" ] }, "UpdateGroupStatus": { "type": "object", + "description": "The status of a UpdateGroup.", "properties": { "status": { "$ref": "#/definitions/UpdateStatus", @@ -1781,21 +1776,20 @@ }, "members": { "type": "array", + "description": "The list of member this UpdateGroup updates.", "items": { "$ref": "#/definitions/MemberUpdateStatus" }, + "readOnly": true, "x-ms-identifiers": [ "name" - ], - "description": "The list of member this UpdateGroup updates.", - "x-typespec-name": "MemberUpdateStatus[]", - "readOnly": true + ] } - }, - "description": "The status of a UpdateGroup." + } }, "UpdateRun": { "type": "object", + "description": "An UpdateRun is a multi-stage process to perform update operations across members of a Fleet.", "properties": { "properties": { "$ref": "#/definitions/UpdateRunProperties", @@ -1812,7 +1806,6 @@ "readOnly": true } }, - "description": "An UpdateRun is a multi-stage process to perform update operations across members of a Fleet.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -1821,29 +1814,28 @@ }, "UpdateRunListResult": { "type": "object", + "description": "The response of a UpdateRun list operation.", "properties": { "value": { "type": "array", + "description": "The UpdateRun items on this page", "items": { "$ref": "#/definitions/UpdateRun" - }, - "description": "The UpdateRun items on this page", - "x-typespec-name": "UpdateRun[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a UpdateRun list operation.", "required": [ "value" ] }, "UpdateRunProperties": { "type": "object", + "description": "The properties of the UpdateRun.", "properties": { "provisioningState": { "$ref": "#/definitions/UpdateRunProvisioningState", @@ -1864,7 +1856,6 @@ "readOnly": true } }, - "description": "The properties of the UpdateRun.", "required": [ "managedClusterUpdate" ] @@ -1901,6 +1892,7 @@ }, "UpdateRunStatus": { "type": "object", + "description": "The status of a UpdateRun.", "properties": { "status": { "$ref": "#/definitions/UpdateStatus", @@ -1909,59 +1901,56 @@ }, "stages": { "type": "array", + "description": "The stages composing an update run. Stages are run sequentially withing an UpdateRun.", "items": { "$ref": "#/definitions/UpdateStageStatus" }, + "readOnly": true, "x-ms-identifiers": [ "name" - ], - "description": "The stages composing an update run. Stages are run sequentially withing an UpdateRun.", - "x-typespec-name": "UpdateStageStatus[]", - "readOnly": true + ] } - }, - "description": "The status of a UpdateRun." + } }, "UpdateRunStrategy": { "type": "object", + "description": "The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated.", "properties": { "stages": { "type": "array", + "description": "The list of stages that compose this update run.", "items": { "$ref": "#/definitions/UpdateStage" }, "x-ms-identifiers": [ "name" - ], - "description": "The list of stages that compose this update run.", - "x-typespec-name": "UpdateStage[]" + ] } }, - "description": "The UpdateRunStrategy configures the sequence of Stages and Groups in which the clusters will be updated.", "required": [ "stages" ] }, "UpdateStage": { "type": "object", + "description": "Contains the groups to be updated by an UpdateRun.\nUpdate order:\n- Sequential between stages: Stages run sequentially. The previous stage must complete before the next one starts.\n- Parallel within a stage: Groups within a stage run in parallel.\n- Sequential within a group: Clusters within a group are updated sequentially.", "properties": { "name": { "type": "string", "description": "The name of the stage. Must be unique within the UpdateRun.", - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "minLength": 1, - "maxLength": 50 + "maxLength": 50, + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "groups": { "type": "array", + "description": "A list of group names that compose the stage.\nThe groups will be updated in parallel. Each group name can only appear once in the UpdateRun.", "items": { "$ref": "#/definitions/UpdateGroup" }, "x-ms-identifiers": [ "name" - ], - "description": "A list of group names that compose the stage.\nThe groups will be updated in parallel. Each group name can only appear once in the UpdateRun.", - "x-typespec-name": "UpdateGroup[]" + ] }, "afterStageWaitInSeconds": { "type": "integer", @@ -1969,13 +1958,13 @@ "description": "The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified." } }, - "description": "Contains the groups to be updated by an UpdateRun.\nUpdate order:\n- Sequential between stages: Stages run sequentially. The previous stage must complete before the next one starts.\n- Parallel within a stage: Groups within a stage run in parallel.\n- Sequential within a group: Clusters within a group are updated sequentially.", "required": [ "name" ] }, "UpdateStageStatus": { "type": "object", + "description": "The status of a UpdateStage.", "properties": { "status": { "$ref": "#/definitions/UpdateStatus", @@ -1989,23 +1978,21 @@ }, "groups": { "type": "array", + "description": "The list of groups to be updated as part of this UpdateStage.", "items": { "$ref": "#/definitions/UpdateGroupStatus" }, + "readOnly": true, "x-ms-identifiers": [ "name" - ], - "description": "The list of groups to be updated as part of this UpdateStage.", - "x-typespec-name": "UpdateGroupStatus[]", - "readOnly": true + ] }, "afterStageWaitStatus": { "$ref": "#/definitions/WaitStatus", "description": "The status of the wait period configured on the UpdateStage.", "readOnly": true } - }, - "description": "The status of a UpdateStage." + } }, "UpdateState": { "type": "string", @@ -2025,6 +2012,7 @@ }, "UpdateStatus": { "type": "object", + "description": "The status for an operation or group of operations.", "properties": { "startTime": { "type": "string", @@ -2048,11 +2036,11 @@ "description": "The error details when a failure is encountered.", "readOnly": true } - }, - "description": "The status for an operation or group of operations." + } }, "WaitStatus": { "type": "object", + "description": "The status of the wait duration.", "properties": { "status": { "$ref": "#/definitions/UpdateStatus", @@ -2065,8 +2053,7 @@ "description": "The wait duration configured in seconds.", "readOnly": true } - }, - "description": "The status of the wait duration." + } } }, "parameters": {} diff --git a/specification/containerstorage/ContainerStorage.Management/main.tsp b/specification/containerstorage/ContainerStorage.Management/main.tsp index 5c96967501e9..1522c522969e 100644 --- a/specification/containerstorage/ContainerStorage.Management/main.tsp +++ b/specification/containerstorage/ContainerStorage.Management/main.tsp @@ -51,23 +51,23 @@ model PoolProperties { @doc("Initial capacity of the pool in GiB.") poolCapacityGiB: int64; + // @doc("List of boolean feature-flags, e.g. pool/volume auto-expansion, reclaim policy.") // features?: Record; - @doc("List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.") assignments: string[]; + // Don't include in preview // @doc("Type of encryption. Allowed values: EncryptionAtRestWithPlatformKey.") // encryption: EncryptionType; - @doc("Ephemeral Pool Properties") ephemeralPoolProperties?: EphemeralPoolProperties; + // @doc("Managed Pool Properties") // managedPoolProperties?: ManagedPoolProperties; - @doc("Disk Pool Properties") diskPoolProperties?: DiskPoolProperties; @@ -114,10 +114,10 @@ model DiskPoolProperties { @doc("List of KV pairs to set in StorageClass to configure CSI driver.") csiParams?: Record; + // @doc("Initial capacity of disks. Application volumes must fit within single disks.") // diskCapacityRequest: int64; - @doc("Maximum capacity of the volumes in GiB the user intends to create. Default 512.") maxVolumeCapacityGiB?: int64 = 512; @@ -212,7 +212,7 @@ enum PoolType { enum VolumeBindingMode { /** Immediate binding */ Immediate, - /** Wait for customer to bind */ + /** Wait for customer to bind */ WaitFirstForCustomer, } @@ -285,11 +285,11 @@ model VolumeProperties { @visibility("read") @doc("The status of the last operation.") provisioningState?: ProvisioningState; + // Will not have features enabled by these flags for preview // @doc("List of boolean feature-flags, e.g. pool/volume auto-expansion, reclaim policy.") // features?: Record; - @doc("String KV pairs indicating labels") labels: Record; @@ -298,6 +298,7 @@ model VolumeProperties { @doc("Indicates how the volume should be attached") volumeMode: VolumeMode; + // Set default to RWO in RP and pass it through // @doc("Indicates how the volume can be accessed") // accessMode: AccessMode; @@ -306,7 +307,6 @@ model VolumeProperties { // @doc("Number of replicas") // replicas: int64; - @doc("Reclaim Policy, Delete or Retain") reclaimPolicy: ReclaimPolicy; @@ -318,7 +318,7 @@ model VolumeProperties { // placementProperties: PlacementProperties; } -/** Storage volume mode */ +/** Storage volume mode */ enum VolumeMode { /** FileSystem volume mode */ Filesystem, @@ -385,11 +385,11 @@ model VolumeSnapshotProperties { @visibility("read") @doc("The status of the last operation.") provisioningState?: ProvisioningState; + // Don't include in preview // @doc("List of boolean feature-flags, e.g. pool/volume auto-expansion, reclaim policy.") // features?: Record; - @doc("Reference to the source volume") source: string; diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-03-01-preview/containerstorage.json b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-03-01-preview/containerstorage.json index 47e943df07a7..0afc03d89d2b 100644 --- a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-03-01-preview/containerstorage.json +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/preview/2023-03-01-preview/containerstorage.json @@ -55,10 +55,10 @@ "paths": { "/providers/Microsoft.ContainerStorage/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -79,9 +79,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Operations_List_MaximumSet_Gen": { "$ref": "./examples/Operations_List_MaximumSet_Gen.json" @@ -89,15 +86,18 @@ "Operations_List_MinimumSet_Gen": { "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerStorage/pools": { "get": { + "operationId": "Pools_ListBySubscription", "tags": [ "Pools" ], - "operationId": "Pools_ListBySubscription", "description": "List Pool resources by subscription ID", "parameters": [ { @@ -121,9 +121,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Pools_ListBySubscription_MaximumSet_Gen": { "$ref": "./examples/Pools_ListBySubscription_MaximumSet_Gen.json" @@ -131,15 +128,18 @@ "Pools_ListBySubscription_MinimumSet_Gen": { "$ref": "./examples/Pools_ListBySubscription_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools": { "get": { + "operationId": "Pools_ListByResourceGroup", "tags": [ "Pools" ], - "operationId": "Pools_ListByResourceGroup", "description": "List Pool resources by resource group", "parameters": [ { @@ -166,9 +166,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Pools_ListByResourceGroup_MaximumSet_Gen": { "$ref": "./examples/Pools_ListByResourceGroup_MaximumSet_Gen.json" @@ -176,15 +173,18 @@ "Pools_ListByResourceGroup_MinimumSet_Gen": { "$ref": "./examples/Pools_ListByResourceGroup_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}": { "get": { + "operationId": "Pools_Get", "tags": [ "Pools" ], - "operationId": "Pools_Get", "description": "Get a Pool", "parameters": [ { @@ -199,8 +199,8 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -229,10 +229,10 @@ } }, "put": { + "operationId": "Pools_CreateOrUpdate", "tags": [ "Pools" ], - "operationId": "Pools_CreateOrUpdate", "description": "Create a Pool", "parameters": [ { @@ -247,16 +247,16 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Pool" } @@ -271,15 +271,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Pool" } }, "default": { @@ -302,12 +302,12 @@ }, "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "Pools_Update", "tags": [ "Pools" ], - "operationId": "Pools_Delete", - "description": "Delete a Pool", + "description": "Update a Pool", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -321,33 +321,42 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "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/PoolUpdate" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + } }, "202": { - "description": "Resource deletion accepted.", + "description": "Resource update request 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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -356,11 +365,11 @@ } }, "x-ms-examples": { - "Pools_Delete_MaximumSet_Gen": { - "$ref": "./examples/Pools_Delete_MaximumSet_Gen.json" + "Pools_Update_MaximumSet_Gen": { + "$ref": "./examples/Pools_Update_MaximumSet_Gen.json" }, - "Pools_Delete_MinimumSet_Gen": { - "$ref": "./examples/Pools_Delete_MinimumSet_Gen.json" + "Pools_Update_MinimumSet_Gen": { + "$ref": "./examples/Pools_Update_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { @@ -368,12 +377,12 @@ }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "Pools_Delete", "tags": [ "Pools" ], - "operationId": "Pools_Update", - "description": "Update a Pool", + "description": "Delete a Pool", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -387,42 +396,33 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/PoolUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Pool" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -431,11 +431,11 @@ } }, "x-ms-examples": { - "Pools_Update_MaximumSet_Gen": { - "$ref": "./examples/Pools_Update_MaximumSet_Gen.json" + "Pools_Delete_MaximumSet_Gen": { + "$ref": "./examples/Pools_Delete_MaximumSet_Gen.json" }, - "Pools_Update_MinimumSet_Gen": { - "$ref": "./examples/Pools_Update_MinimumSet_Gen.json" + "Pools_Delete_MinimumSet_Gen": { + "$ref": "./examples/Pools_Delete_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { @@ -444,13 +444,13 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumeSnapshots": { "get": { + "operationId": "VolumeSnapshots_ListByPool", "tags": [ - "Volumes" + "VolumeSnapshots" ], - "operationId": "Volumes_ListByPool", - "description": "List Volume resources by Pool", + "description": "List VolumeSnapshot resources by Pool", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -464,8 +464,8 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -474,7 +474,7 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/VolumeListResult" + "$ref": "#/definitions/VolumeSnapshotListResult" } }, "default": { @@ -484,26 +484,26 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Volumes_ListByPool_MaximumSet_Gen": { - "$ref": "./examples/Volumes_ListByPool_MaximumSet_Gen.json" + "VolumeSnapshots_ListByPool_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_ListByPool_MaximumSet_Gen.json" }, - "Volumes_ListByPool_MinimumSet_Gen": { - "$ref": "./examples/Volumes_ListByPool_MinimumSet_Gen.json" + "VolumeSnapshots_ListByPool_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_ListByPool_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumeSnapshots/{volumeSnapshotName}": { "get": { + "operationId": "VolumeSnapshots_Get", "tags": [ - "Volumes" + "VolumeSnapshots" ], - "operationId": "Volumes_Get", - "description": "Get a Volume", + "description": "Get a VolumeSnapshot", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -517,16 +517,16 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeName", + "name": "volumeSnapshotName", "in": "path", + "description": "Volume Snapshot Resource", "required": true, - "description": "Volume Resource", "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -535,7 +535,7 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/Volume" + "$ref": "#/definitions/VolumeSnapshot" } }, "default": { @@ -546,20 +546,20 @@ } }, "x-ms-examples": { - "Volumes_Get_MaximumSet_Gen": { - "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" + "VolumeSnapshots_Get_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Get_MaximumSet_Gen.json" }, - "Volumes_Get_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Get_MinimumSet_Gen.json" + "VolumeSnapshots_Get_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Get_MinimumSet_Gen.json" } } }, "put": { + "operationId": "VolumeSnapshots_CreateOrUpdate", "tags": [ - "Volumes" + "VolumeSnapshots" ], - "operationId": "Volumes_CreateOrUpdate", - "description": "Create a Volume", + "description": "Create a VolumeSnapshot", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -573,26 +573,26 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeName", + "name": "volumeSnapshotName", "in": "path", + "description": "Volume Snapshot Resource", "required": true, - "description": "Volume Resource", "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { - "$ref": "#/definitions/Volume" + "$ref": "#/definitions/VolumeSnapshot" } } ], @@ -600,20 +600,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/Volume" + "$ref": "#/definitions/VolumeSnapshot" } }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/VolumeSnapshot" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Volume" } }, "default": { @@ -624,11 +624,11 @@ } }, "x-ms-examples": { - "Volumes_CreateOrUpdate_MaximumSet_Gen": { - "$ref": "./examples/Volumes_CreateOrUpdate_MaximumSet_Gen.json" + "VolumeSnapshots_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_CreateOrUpdate_MaximumSet_Gen.json" }, - "Volumes_CreateOrUpdate_MinimumSet_Gen": { - "$ref": "./examples/Volumes_CreateOrUpdate_MinimumSet_Gen.json" + "VolumeSnapshots_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_CreateOrUpdate_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { @@ -636,12 +636,12 @@ }, "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "VolumeSnapshots_Update", "tags": [ - "Volumes" + "VolumeSnapshots" ], - "operationId": "Volumes_Delete", - "description": "Delete a Volume", + "description": "Update a VolumeSnapshot", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -655,41 +655,50 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeName", + "name": "volumeSnapshotName", "in": "path", + "description": "Volume Snapshot Resource", "required": true, - "description": "Volume Resource", "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/VolumeSnapshotUpdate" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VolumeSnapshot" + } }, "202": { - "description": "Resource deletion accepted.", + "description": "Resource update request 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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -698,24 +707,24 @@ } }, "x-ms-examples": { - "Volumes_Delete_MaximumSet_Gen": { - "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" + "VolumeSnapshots_Update_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Update_MaximumSet_Gen.json" }, - "Volumes_Delete_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Delete_MinimumSet_Gen.json" + "VolumeSnapshots_Update_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Update_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "VolumeSnapshots_Delete", "tags": [ - "Volumes" + "VolumeSnapshots" ], - "operationId": "Volumes_Update", - "description": "Update a Volume", + "description": "Delete a VolumeSnapshot", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -729,50 +738,41 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeName", + "name": "volumeSnapshotName", "in": "path", + "description": "Volume Snapshot Resource", "required": true, - "description": "Volume Resource", "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/VolumeUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Volume" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -781,11 +781,11 @@ } }, "x-ms-examples": { - "Volumes_Update_MaximumSet_Gen": { - "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" + "VolumeSnapshots_Delete_MaximumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Delete_MaximumSet_Gen.json" }, - "Volumes_Update_MinimumSet_Gen": { - "$ref": "./examples/Volumes_Update_MinimumSet_Gen.json" + "VolumeSnapshots_Delete_MinimumSet_Gen": { + "$ref": "./examples/VolumeSnapshots_Delete_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { @@ -794,13 +794,13 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumeSnapshots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes": { "get": { + "operationId": "Volumes_ListByPool", "tags": [ - "VolumeSnapshots" + "Volumes" ], - "operationId": "VolumeSnapshots_ListByPool", - "description": "List VolumeSnapshot resources by Pool", + "description": "List Volume resources by Pool", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -814,8 +814,8 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -824,7 +824,7 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/VolumeSnapshotListResult" + "$ref": "#/definitions/VolumeListResult" } }, "default": { @@ -834,26 +834,26 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "VolumeSnapshots_ListByPool_MaximumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_ListByPool_MaximumSet_Gen.json" + "Volumes_ListByPool_MaximumSet_Gen": { + "$ref": "./examples/Volumes_ListByPool_MaximumSet_Gen.json" }, - "VolumeSnapshots_ListByPool_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_ListByPool_MinimumSet_Gen.json" + "Volumes_ListByPool_MinimumSet_Gen": { + "$ref": "./examples/Volumes_ListByPool_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumeSnapshots/{volumeSnapshotName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}": { "get": { + "operationId": "Volumes_Get", "tags": [ - "VolumeSnapshots" + "Volumes" ], - "operationId": "VolumeSnapshots_Get", - "description": "Get a VolumeSnapshot", + "description": "Get a Volume", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -867,16 +867,16 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeSnapshotName", + "name": "volumeName", "in": "path", + "description": "Volume Resource", "required": true, - "description": "Volume Snapshot Resource", "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -885,7 +885,7 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/VolumeSnapshot" + "$ref": "#/definitions/Volume" } }, "default": { @@ -896,20 +896,20 @@ } }, "x-ms-examples": { - "VolumeSnapshots_Get_MaximumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Get_MaximumSet_Gen.json" + "Volumes_Get_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" }, - "VolumeSnapshots_Get_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Get_MinimumSet_Gen.json" + "Volumes_Get_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Get_MinimumSet_Gen.json" } } }, "put": { + "operationId": "Volumes_CreateOrUpdate", "tags": [ - "VolumeSnapshots" + "Volumes" ], - "operationId": "VolumeSnapshots_CreateOrUpdate", - "description": "Create a VolumeSnapshot", + "description": "Create a Volume", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -923,26 +923,26 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeSnapshotName", + "name": "volumeName", "in": "path", + "description": "Volume Resource", "required": true, - "description": "Volume Snapshot Resource", "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { - "$ref": "#/definitions/VolumeSnapshot" + "$ref": "#/definitions/Volume" } } ], @@ -950,20 +950,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/VolumeSnapshot" + "$ref": "#/definitions/Volume" } }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Volume" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/VolumeSnapshot" } }, "default": { @@ -974,11 +974,11 @@ } }, "x-ms-examples": { - "VolumeSnapshots_CreateOrUpdate_MaximumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_CreateOrUpdate_MaximumSet_Gen.json" + "Volumes_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Volumes_CreateOrUpdate_MaximumSet_Gen.json" }, - "VolumeSnapshots_CreateOrUpdate_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_CreateOrUpdate_MinimumSet_Gen.json" + "Volumes_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/Volumes_CreateOrUpdate_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { @@ -986,12 +986,12 @@ }, "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "Volumes_Update", "tags": [ - "VolumeSnapshots" + "Volumes" ], - "operationId": "VolumeSnapshots_Delete", - "description": "Delete a VolumeSnapshot", + "description": "Update a Volume", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1005,41 +1005,50 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeSnapshotName", + "name": "volumeName", "in": "path", + "description": "Volume Resource", "required": true, - "description": "Volume Snapshot Resource", "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/VolumeUpdate" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Volume" + } }, "202": { - "description": "Resource deletion accepted.", + "description": "Resource update request 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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -1048,11 +1057,11 @@ } }, "x-ms-examples": { - "VolumeSnapshots_Delete_MaximumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Delete_MaximumSet_Gen.json" + "Volumes_Update_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" }, - "VolumeSnapshots_Delete_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Delete_MinimumSet_Gen.json" + "Volumes_Update_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Update_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { @@ -1060,12 +1069,12 @@ }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "Volumes_Delete", "tags": [ - "VolumeSnapshots" + "Volumes" ], - "operationId": "VolumeSnapshots_Update", - "description": "Update a VolumeSnapshot", + "description": "Delete a Volume", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1079,50 +1088,41 @@ { "name": "poolName", "in": "path", - "required": true, "description": "Pool Object", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "volumeSnapshotName", + "name": "volumeName", "in": "path", + "description": "Volume Resource", "required": true, - "description": "Volume Snapshot Resource", "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/VolumeSnapshotUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/VolumeSnapshot" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -1131,15 +1131,15 @@ } }, "x-ms-examples": { - "VolumeSnapshots_Update_MaximumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Update_MaximumSet_Gen.json" + "Volumes_Delete_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" }, - "VolumeSnapshots_Update_MinimumSet_Gen": { - "$ref": "./examples/VolumeSnapshots_Update_MinimumSet_Gen.json" + "Volumes_Delete_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "final-state-via": "location" }, "x-ms-long-running-operation": true } @@ -1244,14 +1244,14 @@ }, "DiskPoolProperties": { "type": "object", + "description": "Disk Pool Properties", "properties": { "csiParams": { "type": "object", + "description": "List of KV pairs to set in StorageClass to configure CSI driver.", "additionalProperties": { "type": "string" - }, - "description": "List of KV pairs to set in StorageClass to configure CSI driver.", - "x-typespec-name": "Record" + } }, "maxVolumeCapacityGiB": { "type": "integer", @@ -1261,17 +1261,16 @@ }, "disks": { "type": "array", + "description": "Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).", "items": { "type": "string" - }, - "description": "Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).", - "x-typespec-name": "string[]" + } } - }, - "description": "Disk Pool Properties" + } }, "DiskProperties": { "type": "object", + "description": "Disk Properties Model", "properties": { "resourceId": { "type": "string", @@ -1303,7 +1302,6 @@ "description": "Used to import SSD to discover WWN" } }, - "description": "Disk Properties Model", "required": [ "resourceId", "wwn", @@ -1340,6 +1338,7 @@ }, "ElasticSanPoolProperties": { "type": "object", + "description": "Elastic San Pool Properties", "properties": { "sanName": { "type": "string", @@ -1354,7 +1353,6 @@ "description": "Volume group of an existing SAN." } }, - "description": "Elastic San Pool Properties", "required": [ "sanName", "resourceGroup", @@ -1363,6 +1361,7 @@ }, "ElasticSanPoolPropertiesUpdate": { "type": "object", + "description": "Elastic San Pool Properties", "properties": { "sanName": { "type": "string", @@ -1376,8 +1375,7 @@ "type": "string", "description": "Volume group of an existing SAN." } - }, - "description": "Elastic San Pool Properties" + } }, "EncryptionType": { "type": "string", @@ -1399,22 +1397,21 @@ }, "EphemeralPoolProperties": { "type": "object", + "description": "Ephemeral Pool Properties", "properties": { "diskSelector": { "type": "array", + "description": "Template name or KV pairs containing disk selection criteria, e.g. model=\"Microsoft NVMe Direct Disk\" to match all Lsv2 NVMe disks.", "items": { "type": "string" - }, - "description": "Template name or KV pairs containing disk selection criteria, e.g. model=\"Microsoft NVMe Direct Disk\" to match all Lsv2 NVMe disks.", - "x-typespec-name": "string[]" + } }, "disks": { "type": "array", + "description": "Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).", "items": { "type": "string" - }, - "description": "Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).", - "x-typespec-name": "string[]" + } }, "diskFormat": { "type": "boolean", @@ -1422,7 +1419,6 @@ "default": false } }, - "description": "Ephemeral Pool Properties", "required": [ "diskSelector", "disks" @@ -1430,38 +1426,37 @@ }, "EphemeralPoolPropertiesUpdate": { "type": "object", + "description": "Ephemeral Pool Properties", "properties": { "diskSelector": { "type": "array", + "description": "Template name or KV pairs containing disk selection criteria, e.g. model=\"Microsoft NVMe Direct Disk\" to match all Lsv2 NVMe disks.", "items": { "type": "string" - }, - "description": "Template name or KV pairs containing disk selection criteria, e.g. model=\"Microsoft NVMe Direct Disk\" to match all Lsv2 NVMe disks.", - "x-typespec-name": "string[]" + } }, "disks": { "type": "array", + "description": "Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).", "items": { "type": "string" - }, - "description": "Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags).", - "x-typespec-name": "string[]" + } }, "diskFormat": { "type": "boolean", "description": "Consent to format the local disks.", "default": false } - }, - "description": "Ephemeral Pool Properties" + } }, "ManagedPoolProperties": { "type": "object", - "properties": {}, - "description": "Managed Pool Properties" + "description": "Managed Pool Properties", + "properties": {} }, "NetworkRuleSet": { "type": "object", + "description": "Network Rule Set definition", "properties": { "defaultAction": { "$ref": "#/definitions/Action", @@ -1469,14 +1464,12 @@ }, "virtualNetworkRules": { "type": "array", + "description": "Virtual network rules", "items": { "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "Virtual network rules", - "x-typespec-name": "VirtualNetworkRule[]" + } } }, - "description": "Network Rule Set definition", "required": [ "defaultAction", "virtualNetworkRules" @@ -1484,6 +1477,7 @@ }, "PlacementProperties": { "type": "object", + "description": "Placement Properties Model", "properties": { "affinityLabelSelector": { "type": "string", @@ -1498,7 +1492,6 @@ "description": "When unsatisfiable" } }, - "description": "Placement Properties Model", "required": [ "affinityLabelSelector", "antiAffinityLabelSelector", @@ -1507,6 +1500,7 @@ }, "Pool": { "type": "object", + "description": "Pool resource", "properties": { "properties": { "$ref": "#/definitions/PoolProperties", @@ -1518,7 +1512,6 @@ ] } }, - "description": "Pool resource", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -1527,29 +1520,28 @@ }, "PoolListResult": { "type": "object", + "description": "The response of a Pool list operation.", "properties": { "value": { "type": "array", + "description": "The Pool items on this page", "items": { "$ref": "#/definitions/Pool" - }, - "description": "The Pool items on this page", - "x-typespec-name": "Pool[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Pool list operation.", "required": [ "value" ] }, "PoolProperties": { "type": "object", + "description": "Pool Properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", @@ -1562,11 +1554,10 @@ }, "zones": { "type": "array", + "description": "List of availability zones that resources can be created in.", "items": { "type": "string" - }, - "description": "List of availability zones that resources can be created in.", - "x-typespec-name": "string[]" + } }, "poolCapacityGiB": { "type": "integer", @@ -1575,11 +1566,10 @@ }, "assignments": { "type": "array", + "description": "List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.", "items": { "type": "string" - }, - "description": "List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.", - "x-typespec-name": "string[]" + } }, "ephemeralPoolProperties": { "$ref": "#/definitions/EphemeralPoolProperties", @@ -1594,7 +1584,6 @@ "description": "Elastic San Pool Properties" } }, - "description": "Pool Properties", "required": [ "poolType", "zones", @@ -1641,24 +1630,24 @@ }, "PoolUpdate": { "type": "object", + "description": "The type used for update operations of the Pool.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/PoolUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the Pool." + } }, "PoolUpdateProperties": { "type": "object", + "description": "The updatable properties of the Pool.", "properties": { "poolType": { "$ref": "#/definitions/PoolType", @@ -1666,11 +1655,10 @@ }, "zones": { "type": "array", + "description": "List of availability zones that resources can be created in.", "items": { "type": "string" - }, - "description": "List of availability zones that resources can be created in.", - "x-typespec-name": "string[]" + } }, "poolCapacityGiB": { "type": "integer", @@ -1679,11 +1667,10 @@ }, "assignments": { "type": "array", + "description": "List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.", "items": { "type": "string" - }, - "description": "List of resources that should have access to the pool. Typically ARM references to AKS clusters or ACI Container Groups. For local and standard this must be a single reference. For portable there can be many.", - "x-typespec-name": "string[]" + } }, "ephemeralPoolProperties": { "$ref": "#/definitions/EphemeralPoolPropertiesUpdate", @@ -1697,8 +1684,7 @@ "$ref": "#/definitions/ElasticSanPoolPropertiesUpdate", "description": "Elastic San Pool Properties" } - }, - "description": "The updatable properties of the Pool." + } }, "ProtocolType": { "type": "string", @@ -1804,6 +1790,7 @@ }, "Sku": { "type": "object", + "description": "Sku definition", "properties": { "name": { "$ref": "#/definitions/SkuName", @@ -1814,7 +1801,6 @@ "description": "Sku Account Tier" } }, - "description": "Sku definition", "required": [ "name", "tier" @@ -1852,6 +1838,7 @@ }, "VirtualNetworkRule": { "type": "object", + "description": "Virtual Network Rule definition", "properties": { "action": { "$ref": "#/definitions/Action", @@ -1863,13 +1850,13 @@ "description": "Id of rule" } }, - "description": "Virtual Network Rule definition", "required": [ "id" ] }, "Volume": { "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/VolumeProperties", @@ -1881,7 +1868,6 @@ ] } }, - "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -1914,23 +1900,21 @@ }, "VolumeListResult": { "type": "object", + "description": "The response of a Volume list operation.", "properties": { "value": { "type": "array", + "description": "The Volume items on this page", "items": { "$ref": "#/definitions/Volume" - }, - "description": "The Volume items on this page", - "x-typespec-name": "Volume[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Volume list operation.", "required": [ "value" ] @@ -1961,6 +1945,7 @@ }, "VolumeProperties": { "type": "object", + "description": "Volume Properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", @@ -1969,11 +1954,10 @@ }, "labels": { "type": "object", + "description": "String KV pairs indicating labels", "additionalProperties": { "type": "string" - }, - "description": "String KV pairs indicating labels", - "x-typespec-name": "Record" + } }, "capacityGiB": { "type": "integer", @@ -1990,14 +1974,12 @@ }, "mountOptions": { "type": "array", + "description": "List of string mount options", "items": { "type": "string" - }, - "description": "List of string mount options", - "x-typespec-name": "string[]" + } } }, - "description": "Volume Properties", "required": [ "labels", "capacityGiB", @@ -2008,6 +1990,7 @@ }, "VolumeSnapshot": { "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/VolumeSnapshotProperties", @@ -2019,7 +2002,6 @@ ] } }, - "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -2028,29 +2010,28 @@ }, "VolumeSnapshotListResult": { "type": "object", + "description": "The response of a VolumeSnapshot list operation.", "properties": { "value": { "type": "array", + "description": "The VolumeSnapshot items on this page", "items": { "$ref": "#/definitions/VolumeSnapshot" - }, - "description": "The VolumeSnapshot items on this page", - "x-typespec-name": "VolumeSnapshot[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a VolumeSnapshot list operation.", "required": [ "value" ] }, "VolumeSnapshotProperties": { "type": "object", + "description": "Volume Snapshot Properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", @@ -2071,14 +2052,12 @@ }, "mountOptions": { "type": "array", + "description": "List of string mount options", "items": { "type": "string" - }, - "description": "List of string mount options", - "x-typespec-name": "string[]" + } } }, - "description": "Volume Snapshot Properties", "required": [ "source", "volumeMode", @@ -2088,16 +2067,17 @@ }, "VolumeSnapshotUpdate": { "type": "object", + "description": "The type used for update operations of the VolumeSnapshot.", "properties": { "properties": { "$ref": "#/definitions/VolumeSnapshotUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the VolumeSnapshot." + } }, "VolumeSnapshotUpdateProperties": { "type": "object", + "description": "The updatable properties of the VolumeSnapshot.", "properties": { "source": { "type": "string", @@ -2113,35 +2093,33 @@ }, "mountOptions": { "type": "array", + "description": "List of string mount options", "items": { "type": "string" - }, - "description": "List of string mount options", - "x-typespec-name": "string[]" + } } - }, - "description": "The updatable properties of the VolumeSnapshot." + } }, "VolumeUpdate": { "type": "object", + "description": "The type used for update operations of the Volume.", "properties": { "properties": { "$ref": "#/definitions/VolumeUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the Volume." + } }, "VolumeUpdateProperties": { "type": "object", + "description": "The updatable properties of the Volume.", "properties": { "labels": { "type": "object", + "description": "String KV pairs indicating labels", "additionalProperties": { "type": "string" - }, - "description": "String KV pairs indicating labels", - "x-typespec-name": "Record" + } }, "capacityGiB": { "type": "integer", @@ -2158,14 +2136,12 @@ }, "mountOptions": { "type": "array", + "description": "List of string mount options", "items": { "type": "string" - }, - "description": "List of string mount options", - "x-typespec-name": "string[]" + } } - }, - "description": "The updatable properties of the Volume." + } }, "WhenUnsatisfiable": { "type": "string", diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/main.tsp b/specification/contosowidgetmanager/Contoso.WidgetManager/main.tsp index 93be75d6dd3d..45bebf834f68 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/main.tsp +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/main.tsp @@ -9,7 +9,7 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; -@useAuth(OAuth2Auth<[ContosoAuthFlow]>) +@useAuth(AadOauth2Auth<["https://contoso.azure.com/.default"]>) @service({ title: "Contoso Widget Manager", }) @@ -23,18 +23,6 @@ enum Versions { v2022_11_01_Preview: "2022-11-01-preview", } -@doc("A faked auth model.") -model ContosoAuthFlow { - @doc("The auth flow type.") - type: OAuth2FlowType.implicit; - - @doc("The auth flow authorization URL.") - authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize"; - - @doc("The auth flow token URL.") - scopes: ["https://security.microsoft.com/.default"]; -} - @doc("A widget.") @resource("widgets") model WidgetSuite { diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json index 14cf35244597..c6658714b8d3 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json @@ -20,19 +20,21 @@ ], "security": [ { - "OAuth2Auth": [ - "https://security.microsoft.com/.default" + "AadOauth2Auth": [ + "https://contoso.azure.com/.default" ] } ], "securityDefinitions": { - "OAuth2Auth": { + "AadOauth2Auth": { "type": "oauth2", - "flow": "implicit", + "description": "The Azure Active Directory OAuth2 Flow", + "flow": "accessCode", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { - "https://security.microsoft.com/.default": "" - } + "https://contoso.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" } }, "tags": [], @@ -51,50 +53,47 @@ "description": "The request has succeeded.", "schema": { "type": "object", + "description": "Paged collection of WidgetSuite items", "properties": { "value": { "type": "array", + "description": "The WidgetSuite items on this page", "items": { "$ref": "#/definitions/WidgetSuite" }, - "x-ms-identifiers": [], - "description": "The WidgetSuite items on this page", - "x-typespec-name": "WidgetSuite[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of WidgetSuite items", "required": [ "value" - ], - "x-typespec-name": "Azure.Core.Foundations.CustomPage" + ] } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Widgets_ListWidgets": { "$ref": "./examples/Widgets_ListWidgetsSample.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -109,8 +108,8 @@ { "name": "widgetName", "in": "path", - "required": true, "description": "The widget name.", + "required": true, "type": "string" } ], @@ -123,14 +122,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -143,6 +142,9 @@ "patch": { "operationId": "Widgets_CreateOrUpdateWidget", "description": "Creates or updates a Widget asynchronously.", + "consumes": [ + "application/merge-patch+json" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -150,15 +152,15 @@ { "name": "widgetName", "in": "path", - "required": true, "description": "The widget name.", + "required": true, "type": "string" }, { "name": "resource", "in": "body", - "required": true, "description": "The resource instance.", + "required": true, "schema": { "$ref": "#/definitions/WidgetSuiteUpdate" } @@ -167,46 +169,43 @@ "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WidgetSuite" + }, "headers": { "Operation-Location": { - "description": "The location for monitoring the operation state.", "type": "string", - "format": "uri" + "format": "uri", + "description": "The location for monitoring the operation state." } - }, - "schema": { - "$ref": "#/definitions/WidgetSuite" } }, "201": { "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/WidgetSuite" + }, "headers": { "Operation-Location": { - "description": "The location for monitoring the operation state.", "type": "string", - "format": "uri" + "format": "uri", + "description": "The location for monitoring the operation state." } - }, - "schema": { - "$ref": "#/definitions/WidgetSuite" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/merge-patch+json" - ], "x-ms-examples": { "Widgets_CreateOrUpdateWidget": { "$ref": "./examples/Widgets_CreateOrUpdateWidgetSample.json" @@ -223,23 +222,17 @@ { "name": "widgetName", "in": "path", - "required": true, "description": "The widget name.", + "required": true, "type": "string" } ], "responses": { "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", - "headers": { - "Operation-Location": { - "description": "The location for monitoring the operation state.", - "type": "string", - "format": "uri" - } - }, "schema": { "type": "object", + "description": "Provides status details for long running operations.", "properties": { "id": { "type": "string", @@ -254,24 +247,29 @@ "description": "Error object that describes the error when status is \"Failed\"." } }, - "description": "Provides status details for long running operations.", "required": [ "id", "status" - ], - "x-typespec-name": "Azure.Core.Foundations.OperationStatus" + ] + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -293,15 +291,15 @@ { "name": "widgetName", "in": "path", - "required": true, "description": "The widget name.", + "required": true, "type": "string" }, { "name": "operationId", "in": "path", - "required": true, "description": "The unique ID of the operation.", + "required": true, "type": "string" } ], @@ -310,6 +308,7 @@ "description": "The request has succeeded.", "schema": { "type": "object", + "description": "Provides status details for long running operations.", "properties": { "id": { "type": "string", @@ -328,24 +327,22 @@ "description": "The result of the operation." } }, - "description": "Provides status details for long running operations.", "required": [ "id", "status" - ], - "x-typespec-name": "Azure.Core.ResourceOperationStatus" + ] } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -360,6 +357,7 @@ "definitions": { "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -375,19 +373,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -395,19 +391,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -417,8 +414,7 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "Azure.Core.Foundations.OperationState": { "type": "string", @@ -456,42 +452,9 @@ ] } }, - "ContosoAuthFlow": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "implicit" - ], - "description": "The auth flow type." - }, - "authorizationUrl": { - "type": "string", - "enum": [ - "https://login.microsoftonline.com/common/oauth2/authorize" - ], - "x-ms-enum": { - "modelAsString": false - }, - "description": "The auth flow authorization URL." - }, - "scopes": { - "type": "array", - "items": {}, - "x-typespec-name": "[https://security.microsoft.com/.default]", - "description": "The auth flow token URL." - } - }, - "description": "A faked auth model.", - "required": [ - "type", - "authorizationUrl", - "scopes" - ] - }, "FakedSharedModel": { "type": "object", + "description": "Faked shared model", "properties": { "tag": { "type": "string", @@ -503,7 +466,6 @@ "description": "The created date." } }, - "description": "Faked shared model", "required": [ "tag", "createdAt" @@ -511,6 +473,7 @@ }, "FakedSharedModelUpdate": { "type": "object", + "description": "Faked shared model", "properties": { "tag": { "type": "string", @@ -521,8 +484,7 @@ "format": "date-time", "description": "The created date." } - }, - "description": "Faked shared model" + } }, "Versions": { "type": "string", @@ -544,6 +506,7 @@ }, "WidgetSuite": { "type": "object", + "description": "A widget.", "properties": { "name": { "type": "string", @@ -559,7 +522,6 @@ "description": "The faked shared model." } }, - "description": "A widget.", "required": [ "name", "manufacturerId" @@ -567,6 +529,7 @@ }, "WidgetSuiteUpdate": { "type": "object", + "description": "A widget.", "properties": { "manufacturerId": { "type": "string", @@ -576,20 +539,19 @@ "$ref": "#/definitions/FakedSharedModelUpdate", "description": "The faked shared model." } - }, - "description": "A widget." + } } }, "parameters": { "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json index a0ef4f0df639..f29825584c14 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2023-05-18-preview/controller.json @@ -385,7 +385,6 @@ ], "properties": { "properties": { - "readOnly": true, "$ref": "#/definitions/DelegatedControllerProperties", "description": "Properties of the provision operation request." } diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/dynatrace.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/dynatrace.json new file mode 100644 index 000000000000..7e015316d907 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/dynatrace.json @@ -0,0 +1,2244 @@ +{ + "swagger": "2.0", + "info": { + "title": "Dynatrace.Observability", + "version": "2023-04-27" + }, + "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": "Monitors" + }, + { + "name": "Operations" + }, + { + "name": "TagRules" + }, + { + "name": "SingleSignOn" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/listMonitoredResources": { + "post": { + "operationId": "Monitors_ListMonitoredResources", + "summary": "List the resources currently being monitored by the Dynatrace monitor resource.", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "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/Dynatrace.Observability/monitors/{monitorName}/getVMHostPayload": { + "post": { + "operationId": "Monitors_GetVMHostPayload", + "summary": "Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM.", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMExtensionPayload" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-examples": { + "Monitors_GetVMHostPayload_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetVMHostPayload_MaximumSet_Gen.json" + }, + "Monitors_GetVMHostPayload_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetVMHostPayload_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}": { + "get": { + "operationId": "Monitors_Get", + "summary": "Get a MonitorResource", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitorResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-examples": { + "Monitors_Get_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Get_MaximumSet_Gen.json" + }, + "Monitors_Get_MinimumSet_Gen": { + "$ref": "./examples/Monitors_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Monitors_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "summary": "Create a MonitorResource", + "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/MonitorNameParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/MonitorResource" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitorResource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitorResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-examples": { + "Monitors_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Monitors_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/Monitors_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "Monitors_Update", + "summary": "Update a MonitorResource", + "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/MonitorNameParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/MonitorResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitorResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-examples": { + "Monitors_Update_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Update_MaximumSet_Gen.json" + }, + "Monitors_Update_MinimumSet_Gen": { + "$ref": "./examples/Monitors_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Monitors_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "summary": "Delete a MonitorResource", + "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/MonitorNameParameter" + } + ], + "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/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "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" + } + } + } + }, + "/providers/Dynatrace.Observability/operations": { + "get": { + "operationId": "Operations_List", + "summary": "List the operations for Dynatrace.Observability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Operations" + ], + "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/Dynatrace.Observability/monitors": { + "get": { + "operationId": "Monitors_ListBySubscriptionId", + "summary": "List all MonitorResource by subscriptionId", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitorResourceListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListBySubscriptionId_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListBySubscriptionId_MaximumSet_Gen.json" + }, + "Monitors_ListBySubscriptionId_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListBySubscriptionId_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors": { + "get": { + "operationId": "Monitors_ListByResourceGroup", + "summary": "List MonitorResource resources by resource group", + "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": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitorResourceListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json" + }, + "Monitors_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/tagRules/{ruleSetName}": { + "get": { + "operationId": "TagRules_Get", + "summary": "Get a TagRule", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "TagRules" + ], + "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": { + "operationId": "TagRules_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "summary": "Create a TagRule", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + }, + { + "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.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "TagRules" + ], + "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" + } + } + }, + "delete": { + "operationId": "TagRules_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "summary": "Delete a TagRule", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "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/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "TagRules" + ], + "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" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/tagRules": { + "get": { + "operationId": "TagRules_List", + "summary": "List all TagRule by monitorName", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRuleListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "TagRules" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List_MaximumSet_Gen": { + "$ref": "./examples/TagRules_List_MaximumSet_Gen.json" + }, + "TagRules_List_MinimumSet_Gen": { + "$ref": "./examples/TagRules_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Dynatrace.Observability/getMarketplaceSaaSResourceDetails": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMarketplaceSaaSResourceDetails", + "description": "Get Marketplace SaaS resource details of a tenant under a specific subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceSaaSResourceDetailsResponse" + } + }, + "404": { + "description": "No Marketplace SaaS resource found for the given tenant Id", + "x-ms-error-response": true + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMarketplaceSaaSResourceDetails_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMarketplaceSaaSResourceDetails_MaximumSet_Gen.json" + }, + "Monitors_GetMarketplaceSaaSResourceDetails_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMarketplaceSaaSResourceDetails_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}": { + "put": { + "operationId": "SingleSignOn_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "summary": "Create a DynatraceSingleSignOnResource", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/DynatraceSingleSignOnResource" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynatraceSingleSignOnResource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynatraceSingleSignOnResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "SingleSignOn" + ], + "x-ms-examples": { + "SingleSignOn_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/SingleSignOn_CreateOrUpdate_MaximumSet_Gen.json" + }, + "SingleSignOn_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/SingleSignOn_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "get": { + "operationId": "SingleSignOn_Get", + "summary": "Get a DynatraceSingleSignOnResource", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynatraceSingleSignOnResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "SingleSignOn" + ], + "x-ms-examples": { + "SingleSignOn_Get_MaximumSet_Gen": { + "$ref": "./examples/SingleSignOn_Get_MaximumSet_Gen.json" + }, + "SingleSignOn_Get_MinimumSet_Gen": { + "$ref": "./examples/SingleSignOn_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/singleSignOnConfigurations": { + "get": { + "operationId": "SingleSignOn_List", + "summary": "List all DynatraceSingleSignOnResource by monitorName", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynatraceSingleSignOnResourceListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "SingleSignOn" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SingleSignOn_List_MaximumSet_Gen": { + "$ref": "./examples/SingleSignOn_List_MaximumSet_Gen.json" + }, + "SingleSignOn_List_MinimumSet_Gen": { + "$ref": "./examples/SingleSignOn_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/listHosts": { + "post": { + "operationId": "Monitors_ListHosts", + "summary": "List the VM/VMSS resources currently being monitored by the Dynatrace resource.", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMHostsListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "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/Dynatrace.Observability/monitors/{monitorName}/getMetricStatus": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricStatus", + "description": "Get metric status", + "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" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitor resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricsStatusResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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/Dynatrace.Observability/monitors/{monitorName}/listAppServices": { + "post": { + "operationId": "Monitors_ListAppServices", + "summary": "Gets list of App Services with Dynatrace PaaS OneAgent enabled", + "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/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppServiceListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "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/Dynatrace.Observability/monitors/{monitorName}/getSSODetails": { + "post": { + "operationId": "Monitors_GetSSODetails", + "summary": "Gets the SSO configuration details from the partner.", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/SSODetailsRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SSODetailsResponse" + } + }, + "401": { + "description": "User has insufficient permissions to update SSO configuration", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-examples": { + "Monitors_GetSSODetails_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetSSODetails_MaximumSet_Gen.json" + }, + "Monitors_GetSSODetails_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetSSODetails_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Dynatrace.Observability/monitors/{monitorName}/listLinkableEnvironments": { + "post": { + "operationId": "Monitors_ListLinkableEnvironments", + "summary": "Gets all the Dynatrace environments that a user can link a azure resource to", + "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/MonitorNameParameter" + }, + { + "$ref": "#/parameters/LinkableEnvRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/LinkableEnvironmentListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "tags": [ + "Monitors" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListLinkableEnvironments_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListLinkableEnvironments_MaximumSet_Gen.json" + }, + "Monitors_ListLinkableEnvironments_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListLinkableEnvironments_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "MonitoredResourceListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredResource" + }, + "x-cadl-name": "MonitoredResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "List of all the resources being monitored by Dynatrace monitor resource" + }, + "MarketplaceSaaSResourceDetailsResponse": { + "type": "object", + "properties": { + "marketplaceSaaSResourceId": { + "type": "string", + "description": "Id of the Marketplace SaaS Resource" + }, + "planId": { + "type": "string", + "description": "Id of the plan" + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + } + }, + "description": "Marketplace SaaS resource details linked to the given tenant Id" + }, + "VMExtensionPayload": { + "type": "object", + "properties": { + "ingestionKey": { + "type": "string", + "description": "Ingestion key of the environment" + }, + "environmentId": { + "type": "string", + "description": "Id of the environment created" + } + }, + "description": "Response of payload to be passed while installing VM agent." + }, + "VMHostsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VMInfo" + }, + "description": "The items on this page", + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "Response of a list VM Host Operation." + }, + "AppServiceInfo": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "App service resource ID" + }, + "version": { + "type": "string", + "description": "Version of the Dynatrace agent installed on the App Service." + }, + "monitoringType": { + "$ref": "#/definitions/MonitoringType", + "description": "The monitoring mode of OneAgent" + }, + "autoUpdateSetting": { + "$ref": "#/definitions/AutoUpdateSetting", + "description": "Update settings of OneAgent." + }, + "updateStatus": { + "$ref": "#/definitions/UpdateStatus", + "description": "The current update status of OneAgent." + }, + "availabilityState": { + "$ref": "#/definitions/AvailabilityState", + "description": "The availability state of OneAgent." + }, + "logModule": { + "$ref": "#/definitions/LogModule", + "description": "Tells whether log modules are enabled or not" + }, + "hostGroup": { + "type": "string", + "description": "The name of the host group" + }, + "hostName": { + "type": "string", + "description": "The name of the host" + } + }, + "description": "Details of App Services having Dynatrace OneAgent installed" + }, + "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" + }, + "AppServiceListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceInfo" + }, + "description": "The items on this page", + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "Response of a list App Services Operation." + }, + "MonitorResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "Dynatrace Monitor Resource", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "MonitorResourceUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "description": "The updatable properties of the MonitorResource." + }, + "MonitorResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitorResource" + }, + "x-cadl-name": "Dynatrace.Observability.MonitorResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a MonitorResource list operation.", + "required": [ + "value" + ] + }, + "TagRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "Tag rules for a monitor resource", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "TagRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagRule" + }, + "x-cadl-name": "Dynatrace.Observability.TagRule[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a TagRule list operation.", + "required": [ + "value" + ] + }, + "DynatraceSingleSignOnResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DynatraceSingleSignOnProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System metadata for this resource.", + "readOnly": true + } + }, + "description": "Single sign-on configurations for a given monitor resource.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "DynatraceSingleSignOnResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DynatraceSingleSignOnResource" + }, + "x-cadl-name": "Dynatrace.Observability.DynatraceSingleSignOnResource[]", + "description": "The items on this page" + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + }, + "description": "The response of a DynatraceSingleSignOnResource list operation.", + "required": [ + "value" + ] + }, + "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 Dynatrace." + }, + "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 Dynatrace." + }, + "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 Dynatrace monitor resource" + }, + "VMInfo": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Azure VM resource ID" + }, + "version": { + "type": "string", + "description": "Version of the Dynatrace agent installed on the VM." + }, + "monitoringType": { + "$ref": "#/definitions/MonitoringType", + "description": "The monitoring mode of OneAgent" + }, + "autoUpdateSetting": { + "$ref": "#/definitions/AutoUpdateSetting", + "description": "Update settings of OneAgent." + }, + "updateStatus": { + "$ref": "#/definitions/UpdateStatus", + "description": "The current update status of OneAgent." + }, + "availabilityState": { + "$ref": "#/definitions/AvailabilityState", + "description": "The availability state of OneAgent." + }, + "logModule": { + "$ref": "#/definitions/LogModule", + "description": "Tells whether log modules are enabled or not" + }, + "hostGroup": { + "type": "string", + "description": "The name of the host group" + }, + "hostName": { + "type": "string", + "description": "The name of the host" + } + }, + "description": "Details of VM Resource having Dynatrace OneAgent installed" + }, + "MonitoringType": { + "type": "string", + "description": "The monitoring mode of OneAgent", + "enum": [ + "CLOUD_INFRASTRUCTURE", + "FULL_STACK" + ], + "x-ms-enum": { + "name": "MonitoringType", + "modelAsString": true + } + }, + "AutoUpdateSetting": { + "type": "string", + "description": "Update settings of OneAgent.", + "enum": [ + "ENABLED", + "DISABLED" + ], + "x-ms-enum": { + "name": "AutoUpdateSetting", + "modelAsString": true + } + }, + "UpdateStatus": { + "type": "string", + "description": "The current update status of OneAgent.", + "enum": [ + "INCOMPATIBLE", + "OUTDATED", + "SCHEDULED", + "SUPPRESSED", + "UNKNOWN", + "UP2DATE", + "UPDATE_IN_PROGRESS", + "UPDATE_PENDING", + "UPDATE_PROBLEM" + ], + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true + } + }, + "AvailabilityState": { + "type": "string", + "description": "The availability state of OneAgent.", + "enum": [ + "CRASHED", + "LOST", + "MONITORED", + "PRE_MONITORED", + "SHUTDOWN", + "UNEXPECTED_SHUTDOWN", + "UNKNOWN", + "UNMONITORED" + ], + "x-ms-enum": { + "name": "AvailabilityState", + "modelAsString": true + } + }, + "LogModule": { + "type": "string", + "description": "Tells whether log modules are enabled or not", + "enum": [ + "ENABLED", + "DISABLED" + ], + "x-ms-enum": { + "name": "LogModule", + "modelAsString": true + } + }, + "MonitorProperties": { + "type": "object", + "properties": { + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus", + "description": "Status of the monitor." + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status." + }, + "dynatraceEnvironmentProperties": { + "$ref": "#/definitions/DynatraceEnvironmentProperties", + "description": "Properties of the Dynatrace environment." + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User info." + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Billing plan information." + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories", + "description": "Liftr Resource category.", + "readOnly": true + }, + "liftrResourcePreference": { + "type": "integer", + "format": "int32", + "description": "The priority of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "Properties specific to the monitor resource." + }, + "IdentityProperties": { + "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/ManagedIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/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" + ] + }, + "MonitoringStatus": { + "type": "string", + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true + } + }, + "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 + } + }, + "DynatraceEnvironmentProperties": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User id" + }, + "accountInfo": { + "$ref": "#/definitions/AccountInfo", + "description": "Dynatrace Account Information" + }, + "environmentInfo": { + "$ref": "#/definitions/EnvironmentInfo", + "description": "Dynatrace Environment Information" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/DynatraceSingleSignOnProperties", + "description": "The details of a Dynatrace single sign-on." + } + }, + "description": "Properties of the Dynatrace environment." + }, + "UserInfo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First Name of the user" + }, + "lastName": { + "type": "string", + "description": "Last Name of the user" + }, + "emailAddress": { + "$ref": "#/definitions/email", + "description": "Email of the user used by Dynatrace for contacting them if needed" + }, + "phoneNumber": { + "type": "string", + "maxLength": 40, + "description": "Phone number of the user used by Dynatrace for contacting them if needed" + }, + "country": { + "type": "string", + "description": "Country of the user" + } + }, + "description": "User info." + }, + "PlanData": { + "type": "object", + "properties": { + "usageType": { + "type": "string", + "description": "different usage type like PAYG/COMMITTED. this could be enum" + }, + "billingCycle": { + "type": "string", + "description": "different billing cycles like MONTHLY/WEEKLY. this could be enum" + }, + "planDetails": { + "type": "string", + "description": "plan id as published by Dynatrace" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "date when plan was applied" + } + }, + "description": "Billing plan information." + }, + "MonitoringTagRulesProperties": { + "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." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "Properties for the Tag rules resource of a Monitor account." + }, + "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-cadl-name": "FilteringTag[]", + "x-ms-identifiers": [], + "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." + }, + "MetricRules": { + "description": "Set of rules for sending metrics for the Monitor resource.", + "type": "object", + "properties": { + "sendingMetrics": { + "$ref": "#/definitions/SendingMetricsStatus", + "description": "Flag specifying if metrics from Azure resources should be sent for the Monitor resource." + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [] + } + } + }, + "DynatraceSingleSignOnProperties": { + "type": "object", + "properties": { + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates", + "description": "State of Single Sign On" + }, + "enterpriseAppId": { + "type": "string", + "description": "Version of the Dynatrace agent installed on the VM." + }, + "singleSignOnUrl": { + "type": "string", + "description": "The login URL specific to this Dynatrace Environment" + }, + "aadDomains": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "array of Aad(azure active directory) domains" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "description": "The details of a Dynatrace single sign-on." + }, + "SendingMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingMetricsStatus", + "modelAsString": true + } + }, + "SendingLogsStatus": { + "type": "string", + "description": "Indicates whether logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingLogsStatus", + "modelAsString": true + } + }, + "LiftrResourceCategories": { + "type": "string", + "description": "Liftr resource category", + "enum": [ + "Unknown", + "MonitorLogs" + ], + "x-ms-enum": { + "name": "LiftrResourceCategories", + "modelAsString": true + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the monitoring resource", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ManagedIdentityType": { + "type": "string", + "description": "The kind of managed identity assigned to this resource.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAndUserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "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.", + "required": [ + "clientId", + "principalId" + ] + }, + "AccountInfo": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "Account Id of the account this environment is linked to" + }, + "regionId": { + "type": "string", + "description": "Region in which the account is created" + } + }, + "description": "Dynatrace Account Information" + }, + "EnvironmentInfo": { + "type": "object", + "properties": { + "environmentId": { + "type": "string", + "description": "Id of the environment created" + }, + "ingestionKey": { + "type": "string", + "description": "Ingestion key of the environment" + }, + "logsIngestionEndpoint": { + "type": "string", + "description": "Ingestion endpoint used for sending logs" + }, + "landingURL": { + "type": "string", + "description": "Landing URL for Dynatrace environment" + } + }, + "description": "Dynatrace Environment Information" + }, + "LinkableEnvironmentRequest": { + "description": "Request for getting all the linkable environments for a user", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Tenant Id of the user in which they want to link the environment" + }, + "userPrincipal": { + "type": "string", + "description": "user principal id of the user" + }, + "region": { + "type": "string", + "description": "Azure region in which we want to link the environment" + } + }, + "required": [ + "tenantId", + "userPrincipal", + "region" + ] + }, + "LinkableEnvironmentResponse": { + "description": "Response for getting all the linkable environments", + "type": "object", + "properties": { + "environmentId": { + "type": "string", + "description": "environment id for which user is an admin" + }, + "environmentName": { + "type": "string", + "description": "Name of the environment" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Billing plan information." + } + } + }, + "LinkableEnvironmentListResponse": { + "description": "Response for getting all the linkable environments", + "type": "object", + "properties": { + "value": { + "description": "List of environments for which user is an admin", + "type": "array", + "items": { + "$ref": "#/definitions/LinkableEnvironmentResponse" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MarketplaceSaaSResourceDetailsRequest": { + "description": "Request for getting Marketplace SaaS resource details for a tenant Id", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Tenant Id" + } + }, + "required": [ + "tenantId" + ] + }, + "SSODetailsRequest": { + "description": "Request for getting sso details for a user", + "type": "object", + "properties": { + "userPrincipal": { + "type": "string", + "description": "user principal id of the user" + } + }, + "required": [ + "userPrincipal" + ] + }, + "SSODetailsResponse": { + "type": "object", + "properties": { + "isSsoEnabled": { + "$ref": "#/definitions/SSOStatus", + "description": "Whether the SSO is enabled for this resource or not." + }, + "metadataUrl": { + "type": "string", + "description": "URL for Azure AD metadata" + }, + "singleSignOnUrl": { + "type": "string", + "description": "The login URL specific to this Dynatrace Environment" + }, + "aadDomains": { + "type": "array", + "items": { + "type": "string" + }, + "description": "array of Aad(azure active directory) domains" + }, + "adminUsers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of admin user emails." + } + }, + "description": "SSO details from the Dynatrace partner" + }, + "SSOStatus": { + "type": "string", + "description": "Indicates whether SSO is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SSOStatus", + "modelAsString": true + } + }, + "email": { + "type": "string", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$", + "description": "Reusable representation of an email address" + }, + "SendAadLogsStatus": { + "type": "string", + "description": "Indicates whether AAD logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendAadLogsStatus", + "modelAsString": true + } + }, + "SendSubscriptionLogsStatus": { + "type": "string", + "description": "Indicates whether subscription logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendSubscriptionLogsStatus", + "modelAsString": true + } + }, + "SendActivityLogsStatus": { + "type": "string", + "description": "Indicates whether activity logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendActivityLogsStatus", + "modelAsString": true + } + }, + "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." + }, + "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 + } + } + }, + "parameters": { + "MonitorNameParameter": { + "x-ms-parameter-location": "method", + "name": "monitorName", + "in": "path", + "required": true, + "description": "Monitor resource name", + "type": "string" + }, + "RuleSetNameParameter": { + "x-ms-parameter-location": "method", + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Monitor resource name", + "type": "string" + }, + "ConfigurationNameParameter": { + "x-ms-parameter-location": "method", + "name": "configurationName", + "in": "path", + "required": true, + "description": "Single Sign On Configuration Name", + "type": "string" + }, + "LinkableEnvRequestParameter": { + "x-ms-parameter-location": "method", + "name": "request", + "in": "body", + "required": true, + "description": "The details of the linkable environment request.", + "schema": { + "$ref": "#/definitions/LinkableEnvironmentRequest" + } + }, + "SSODetailsRequestParameter": { + "x-ms-parameter-location": "method", + "name": "request", + "in": "body", + "description": "The details of the get sso details request.", + "schema": { + "$ref": "#/definitions/SSODetailsRequest" + } + }, + "TenantIdParameter": { + "x-ms-parameter-location": "method", + "name": "request", + "in": "body", + "required": true, + "description": "Tenant Id", + "schema": { + "$ref": "#/definitions/MarketplaceSaaSResourceDetailsRequest" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..0110fa26ae7d --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "resource": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "accountInfo": {}, + "environmentInfo": {}, + "singleSignOnProperties": {} + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "provisioningState": "Accepted" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "4534676867978", + "tenantId": "23456789001", + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "userId": "alice123", + "accountInfo": { + "accountId": "1234567890", + "regionId": "wus2" + }, + "environmentInfo": { + "environmentId": "a23xcv456", + "ingestionKey": "1234567890", + "logsIngestionEndpoint": "https://dynatrace.com" + }, + "singleSignOnProperties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 28, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Dynatrace.Observability/monitors" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "body": { + "identity": { + "principalId": "4534676867978", + "tenantId": "23456789001", + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "userId": "alice123", + "accountInfo": { + "accountId": "1234567890", + "regionId": "wus2" + }, + "environmentInfo": { + "environmentId": "a23xcv456", + "ingestionKey": "1234567890", + "logsIngestionEndpoint": "https://dynatrace.com" + }, + "singleSignOnProperties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 28, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Dynatrace.Observability/monitors" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_CreateOrUpdate_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..fa2c24aa2ba6 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "resource": { + "properties": {}, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "properties": {}, + "location": "West US 2" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "properties": {}, + "location": "West US 2" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..361c7fb6eb55 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..361c7fb6eb55 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMarketplaceSaaSResourceDetails_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMarketplaceSaaSResourceDetails_MaximumSet_Gen.json new file mode 100644 index 000000000000..bf76ceb5fb86 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMarketplaceSaaSResourceDetails_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "operationId": "Monitors_GetMarketplaceSaaSResourceDetails", + "title": "Monitors_GetMarketplaceSaaSResourceDetails_MaximumSet_Gen", + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "nqmcgifgaqlf", + "request": { + "tenantId": "urnmattojzhktcfw" + } + }, + "responses": { + "200": { + "body": { + "marketplaceSaaSResourceId": "owpmulwohq", + "planId": "dsfefsaf", + "marketplaceSubscriptionStatus": "Active" + } + }, + "404": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMarketplaceSaaSResourceDetails_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMarketplaceSaaSResourceDetails_MinimumSet_Gen.json new file mode 100644 index 000000000000..66d64f70090f --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMarketplaceSaaSResourceDetails_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_GetMarketplaceSaaSResourceDetails", + "title": "Monitors_GetMarketplaceSaaSResourceDetails_MinumumSet_Gen", + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "nqmcgifgaqlf", + "request": { + "tenantId": "urnmattojzhktcfw" + } + }, + "responses": { + "200": { + "body": {} + }, + "404": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..880422f99c8b --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MaximumSet_Gen", + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "nqmcgifgaqlf", + "resourceGroupName": "rgDynatrace", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz" + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [ + "/subscriptions/69b51384-146c-4685-9dab-5ae01877d78/resourceGroups/szytr-liftr/providers/Dynatrace.Observability/monitors/szytrz-prod-23-05-23" + ] + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..47ccdfe4d734 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MinimumSet_Gen", + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "nqmcgifgaqlf", + "resourceGroupName": "rgDynatrace", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetSSODetails_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetSSODetails_MaximumSet_Gen.json new file mode 100644 index 000000000000..e9d1b968153a --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetSSODetails_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "request": { + "userPrincipal": "alice@microsoft.com" + } + }, + "responses": { + "200": { + "body": { + "isSsoEnabled": "Enabled", + "metadataUrl": "https://someuri", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ], + "adminUsers": [ + "alice@microsoft.com" + ] + } + }, + "401": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetSSODetails_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetSSODetails_MinimumSet_Gen.json new file mode 100644 index 000000000000..7848814d9929 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetSSODetails_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "request": { + "userPrincipal": "alice@microsoft.com" + } + }, + "responses": { + "200": { + "body": {} + }, + "401": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetVMHostPayload_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetVMHostPayload_MaximumSet_Gen.json new file mode 100644 index 000000000000..b89c8087ddfd --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetVMHostPayload_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "abcd.efg", + "environmentId": "abc123lsjlsfjlfjgd" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetVMHostPayload_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetVMHostPayload_MinimumSet_Gen.json new file mode 100644 index 000000000000..5096e4bd5a1a --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_GetVMHostPayload_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Get_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b6e289556a49 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Get_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "4534676867978", + "tenantId": "23456789001", + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "userId": "alice123", + "accountInfo": { + "accountId": "1234567890", + "regionId": "wus2" + }, + "environmentInfo": { + "environmentId": "a23xcv456", + "ingestionKey": "1234567890", + "logsIngestionEndpoint": "https://dynatrace.com", + "landingURL": "https://a23xcv456.dynatrace.com" + }, + "singleSignOnProperties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 28, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Dynatrace.Observability/monitors" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Get_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..6574db41aa74 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "properties": {}, + "location": "West US 2" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListAppServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..e71632cbef67 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtual1", + "version": "1.2.0", + "monitoringType": "CLOUD_INFRASTRUCTURE", + "autoUpdateSetting": "ENABLED", + "updateStatus": "INCOMPATIBLE", + "availabilityState": "CRASHED", + "logModule": "ENABLED", + "hostGroup": "myGroup", + "hostName": "myName" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListAppServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..5096e4bd5a1a --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e269732b1f8 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "principalId": "4534676867978", + "tenantId": "23456789001", + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "userId": "alice123", + "accountInfo": { + "accountId": "1234567890", + "regionId": "wus2" + }, + "environmentInfo": { + "environmentId": "a23xcv456", + "ingestionKey": "1234567890", + "logsIngestionEndpoint": "https://dynatrace.com", + "landingURL": "https://a23xcv456.dynatrace.com" + }, + "singleSignOnProperties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 28, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Dynatrace.Observability/monitors" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListByResourceGroup_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..8e87f8e23840 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "properties": {}, + "location": "West US 2" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListBySubscriptionId_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListBySubscriptionId_MaximumSet_Gen.json new file mode 100644 index 000000000000..696280441b23 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListBySubscriptionId_MaximumSet_Gen.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "principalId": "4534676867978", + "tenantId": "23456789001", + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "userId": "alice123", + "accountInfo": { + "accountId": "1234567890", + "regionId": "wus2" + }, + "environmentInfo": { + "environmentId": "a23xcv456", + "ingestionKey": "1234567890", + "logsIngestionEndpoint": "https://dynatrace.com", + "landingURL": "https://a23xcv456.dynatrace.com" + }, + "singleSignOnProperties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 28, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Dynatrace.Observability/monitors" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListBySubscriptionId_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListBySubscriptionId_MinimumSet_Gen.json new file mode 100644 index 000000000000..158b142a63c0 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListBySubscriptionId_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "properties": {}, + "location": "West US 2" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListHosts_MaximumSet_Gen.json new file mode 100644 index 000000000000..e71632cbef67 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtual1", + "version": "1.2.0", + "monitoringType": "CLOUD_INFRASTRUCTURE", + "autoUpdateSetting": "ENABLED", + "updateStatus": "INCOMPATIBLE", + "availabilityState": "CRASHED", + "logModule": "ENABLED", + "hostGroup": "myGroup", + "hostName": "myName" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListHosts_MinimumSet_Gen.json new file mode 100644 index 000000000000..5096e4bd5a1a --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListLinkableEnvironments_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListLinkableEnvironments_MaximumSet_Gen.json new file mode 100644 index 000000000000..dcf427b4caa2 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListLinkableEnvironments_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "request": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "userPrincipal": "alice@microsoft.com", + "region": "East US" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "environmentId": "abc.123", + "environmentName": "myEnv", + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + } + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListLinkableEnvironments_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListLinkableEnvironments_MinimumSet_Gen.json new file mode 100644 index 000000000000..fc7902f80c51 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListLinkableEnvironments_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "request": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "userPrincipal": "alice@microsoft.com", + "region": "East US" + } + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json new file mode 100644 index 000000000000..77691e26522d --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor/listMonitoredResources", + "sendingMetrics": "Enabled", + "reasonForMetricsStatus": "CapturedByRules", + "sendingLogs": "Enabled", + "reasonForLogsStatus": "CapturedByRules" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json new file mode 100644 index 000000000000..5096e4bd5a1a --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Update_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..115d3af12199 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Update_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "resource": { + "tags": { + "Environment": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "4534676867978", + "tenantId": "23456789001", + "type": "SystemAssigned" + }, + "properties": { + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "dynatraceEnvironmentProperties": { + "userId": "alice123", + "accountInfo": { + "accountId": "1234567890", + "regionId": "wus2" + }, + "environmentInfo": { + "environmentId": "a23xcv456", + "ingestionKey": "1234567890", + "logsIngestionEndpoint": "https://dynatrace.com", + "landingURL": "https://a23xcv456.dynatrace.com" + }, + "singleSignOnProperties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bobab", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123456", + "country": "westus2" + }, + "planData": { + "usageType": "Committed", + "billingCycle": "Monthly", + "planDetails": "dynatraceapitestplan", + "effectiveDate": "2019-08-30T15:14:33+02:00" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 28, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Dynatrace.Observability/monitors" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Update_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..b2fc04dfc37e --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Monitors_Update_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "resource": {} + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "West US 2" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Operations_List_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..fa311635d889 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-04-27" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Dynatrace.Observability/monitors/write", + "isDataAction": true, + "display": { + "provider": "Dynatrace.Observability", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Operations_List_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..14440c0f2aa5 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-04-27" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_CreateOrUpdate_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..c41ddfaf230b --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "resource": { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ], + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "type": "Dynatrace.Observability/monitors" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "body": { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ], + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "type": "Dynatrace.Observability/monitors" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_CreateOrUpdate_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..5b2707d1bf3c --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "resource": { + "properties": { + "singleSignOnUrl": "https://www.dynatrace.io", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_Get_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d89119061a0f --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_Get_MaximumSet_Gen.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "type": "Dynatrace.Observability/monitors" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_Get_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..332bd90ac165 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_Get_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_List_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..56e3abf2612d --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_List_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "type": "Dynatrace.Observability/monitors" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_List_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..d5dd93534b93 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/SingleSignOn_List_MinimumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnUrl": "https://www.dynatrace.io/IAmSomeHash", + "aadDomains": [ + "mpliftrdt20210811outlook.onmicrosoft.com" + ] + } + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..a22a790fe3e4 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "resource": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "sendingMetrics": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + } + ] + }, + "provisioningState": "Accepted" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "sendingMetrics": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + } + ] + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "name": "default", + "type": "Dynatrace.Observability/monitors/tagRules" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "body": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "sendingMetrics": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + } + ] + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "name": "default", + "type": "Dynatrace.Observability/monitors/tagRules" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..b23f3d8c56fe --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "resource": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "properties": {} + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "properties": {} + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..45bc2f185b78 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..45bc2f185b78 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Get_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..54c7b6f25af4 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "sendingMetrics": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + } + ] + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "name": "default", + "type": "Dynatrace.Observability/monitors/tagRules" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Get_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..407eacbcdcf7 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "properties": {} + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_List_MaximumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..f21ea2a620b0 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_List_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "sendingMetrics": "Enabled", + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + } + ] + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "alice@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-16T04:25:21.040Z", + "lastModifiedBy": "alice@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-16T04:25:21.040Z" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "name": "default", + "type": "Dynatrace.Observability/monitors/tagRules" + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_List_MinimumSet_Gen.json b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..096ba6e903a7 --- /dev/null +++ b/specification/dynatrace/resource-manager/Dynatrace.Observability/stable/2023-04-27/examples/TagRules_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-04-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Dynatrace.Observability/monitors/myMonitor/tagRules/default", + "properties": {} + } + ], + "nextLink": "null" + } + } + } +} diff --git a/specification/dynatrace/resource-manager/readme.md b/specification/dynatrace/resource-manager/readme.md index 5301f2c6467d..515361c1493e 100644 --- a/specification/dynatrace/resource-manager/readme.md +++ b/specification/dynatrace/resource-manager/readme.md @@ -1,6 +1,7 @@ # dynatrace > see https://aka.ms/autorest + This is the AutoRest configuration file for dynatrace. ## Getting Started @@ -8,9 +9,11 @@ This is the AutoRest configuration file for dynatrace. 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. --- @@ -24,16 +27,16 @@ These are the global settings for the dynatrace. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2021-09-01 +tag: package-2023-04-27 ``` -### Tag: package-2021-09-01-preview +### Tag: package-2023-04-27 -These settings apply only when `--tag=package-2021-09-01-preview` is specified on the command line. +These settings apply only when `--tag=package-2023-04-27` is specified on the command line. -```yaml $(tag) == 'package-2021-09-01-preview' +```yaml $(tag) == 'package-2023-04-27' input-file: - - Dynatrace.Observability/preview/2021-09-01-preview/dynatrace.json + - Dynatrace.Observability/stable/2023-04-27/dynatrace.json ``` ### Tag: package-2021-09-01 @@ -45,6 +48,15 @@ input-file: - Dynatrace.Observability/stable/2021-09-01/dynatrace.json ``` +### Tag: package-2021-09-01-preview + +These settings apply only when `--tag=package-2021-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-09-01-preview' +input-file: + - Dynatrace.Observability/preview/2021-09-01-preview/dynatrace.json +``` + --- # Code Generation @@ -60,14 +72,20 @@ swagger-to-sdk: - 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 + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_dynatrace'] ``` -## Az +## Suppression -See configuration in [readme.az.md](./readme.az.md) +``` yaml +suppressions: + - code: SECRET_PROPERTY + from: Dynatrace.Observability/preview/2021-06-01-preview/dynatrace.json + where: $.definitions.VMIngestionDetailsResponse.properties.ingestionKey + reason: Secrets are OK to return in a POST response. +``` ## Go @@ -77,6 +95,10 @@ See configuration in [readme.go.md](./readme.go.md) 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) diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/elasticsan.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/elasticsan.json new file mode 100644 index 000000000000..0680f4e32b69 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/elasticsan.json @@ -0,0 +1,2210 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-12-01-preview", + "title": "ElasticSanManagement" + }, + "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" + } + } + }, + "tags": [ + { + "name": "ElasticSans", + "description": "APIs for ElasticSan operations." + }, + { + "name": "ElasticSanOperations", + "description": "APIs for ElasticSan operations," + }, + { + "name": "VolumeGroups", + "description": "APIs for Volume Group operations." + }, + { + "name": "Volumes", + "description": "APIs for Volume operations." + } + ], + "paths": { + "/providers/Microsoft.ElasticSan/operations": { + "get": { + "tags": [ + "Elastic San Operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of ElasticSan operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "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/Microsoft.ElasticSan/skus": { + "get": { + "tags": [ + "Elastic San Skus" + ], + "summary": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='location eq ' to filter on location.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Lists the available SKUs supported by Microsoft.ElasticSan for given subscription.", + "schema": { + "$ref": "#/definitions/SkuInformationList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Skus_List_MaximumSet_Gen": { + "$ref": "./examples/Skus_List_MaximumSet_Gen.json" + }, + "Skus_List_MinimumSet_Gen": { + "$ref": "./examples/Skus_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ElasticSan/elasticSans": { + "get": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_ListBySubscription", + "description": "Gets a list of ElasticSans in a subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved Elastic San by subscription", + "schema": { + "$ref": "#/definitions/ElasticSanList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticSans_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json" + }, + "ElasticSans_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans": { + "get": { + "tags": [ + "ElasticSan" + ], + "operationId": "ElasticSans_ListByResourceGroup", + "description": "Gets a list of ElasticSan in a resource group.", + "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": { + "200": { + "description": "OK -- Operation completed successfully; retrieved elasticSans by resource group", + "schema": { + "$ref": "#/definitions/ElasticSanList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticSans_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json" + }, + "ElasticSans_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}": { + "put": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Create", + "description": "Create ElasticSan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticSan" + }, + "description": "Elastic San object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Create_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Create_MaximumSet_Gen.json" + }, + "ElasticSans_Create_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Update", + "description": "Update a Elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticSanUpdate" + }, + "description": "Elastic San object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- ElasticSAN properties updated successfully.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Update_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Update_MaximumSet_Gen.json" + }, + "ElasticSans_Update_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Delete", + "description": "Delete a Elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent --ElasticSAN does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ElasticSans_Delete_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Delete_MaximumSet_Gen.json" + }, + "ElasticSans_Delete_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "ElasticSans" + ], + "operationId": "ElasticSans_Get", + "description": "Get a ElasticSan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved ElasticSan.", + "schema": { + "$ref": "#/definitions/ElasticSan" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticSans_Get_MaximumSet_Gen": { + "$ref": "./examples/ElasticSans_Get_MaximumSet_Gen.json" + }, + "ElasticSans_Get_MinimumSet_Gen": { + "$ref": "./examples/ElasticSans_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumeGroups": { + "get": { + "tags": [ + "VolumeGroups" + ], + "description": "List VolumeGroups.", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation completed successfully; retrieved Volume Group List.", + "schema": { + "$ref": "#/definitions/VolumeGroupList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VolumeGroups_ListByElasticSan_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json" + }, + "VolumeGroups_ListByElasticSan_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}": { + "put": { + "tags": [ + "VolumeGroups" + ], + "description": "Create a Volume Group.", + "operationId": "VolumeGroups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeGroup" + }, + "description": "Volume Group object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Create_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Create_MaximumSet_Gen.json" + }, + "VolumeGroups_Create_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VolumeGroups" + ], + "description": "Update an VolumeGroup.", + "operationId": "VolumeGroups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeGroupUpdate" + }, + "description": "Volume Group object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Update_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Update_MaximumSet_Gen.json" + }, + "VolumeGroups_Update_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VolumeGroups" + ], + "description": "Delete an VolumeGroup.", + "operationId": "VolumeGroups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete operation completed successfully." + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeGroups_Delete_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Delete_MaximumSet_Gen.json" + }, + "VolumeGroups_Delete_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VolumeGroups" + ], + "description": "Get an VolumeGroups.", + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved iSCSI Target.", + "schema": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_MaximumSet_Gen": { + "$ref": "./examples/VolumeGroups_Get_MaximumSet_Gen.json" + }, + "VolumeGroups_Get_MinimumSet_Gen": { + "$ref": "./examples/VolumeGroups_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}": { + "put": { + "tags": [ + "Volumes" + ], + "description": "Create a Volume.", + "operationId": "Volumes_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Volume" + }, + "description": "Volume object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Create_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Create_MaximumSet_Gen.json" + }, + "Volumes_Create_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Create_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "description": "Update an Volume.", + "operationId": "Volumes_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VolumeUpdate" + }, + "description": "Volume object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Update_MaximumSet_Gen.json" + }, + "Volumes_Update_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "description": "Delete an Volume.", + "operationId": "Volumes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed successfully." + }, + "202": { + "description": "Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist in the subscription." + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MaximumSet_Gen.json" + }, + "Volumes_Delete_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Volumes" + ], + "description": "Get an Volume.", + "operationId": "Volumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "#/parameters/VolumeNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved Volume.", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get_MaximumSet_Gen": { + "$ref": "./examples/Volumes_Get_MaximumSet_Gen.json" + }, + "Volumes_Get_MinimumSet_Gen": { + "$ref": "./examples/Volumes_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes": { + "get": { + "tags": [ + "Volumes" + ], + "description": "List Volumes in a VolumeGroup.", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/VolumeGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully; retrieved volumes in a volume group.", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Volumes_ListByVolumeGroup_MaximumSet_Gen": { + "$ref": "./examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json" + }, + "Volumes_ListByVolumeGroup_MinimumSet_Gen": { + "$ref": "./examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Update the state of specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Private Endpoint Connection Approval object." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Resource Create or Update operation is successfully completed.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created -- Resource Create; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Create_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Create_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets the specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Get_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes the specified private endpoint connection associated with the Elastic San", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully" + }, + "202": { + "description": "Delete request accepted; operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The Private Endpoint Connection does not exist." + }, + "default": { + "description": "Error from Elastic SAN resource provider.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all Private Endpoint Connections associated with the Elastic San.", + "operationId": "PrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "PrivateEndpointConnections_List_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_List_MaximumSet_Gen.json" + }, + "PrivateEndpointConnections_List_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnections_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByElasticSan", + "description": "Gets the private link resources that need to be created for a elastic San.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ElasticSanNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error from the ElasticSan Resource Provider", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByElasticSan_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json" + }, + "PrivateLinkResources_ListByElasticSan_MinimumSet_Gen": { + "$ref": "./examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json" + } + } + } + } + }, + "parameters": { + "ElasticSanNameParameter": { + "name": "elasticSanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ElasticSan.", + "pattern": "^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "VolumeGroupNameParameter": { + "name": "volumeGroupName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the VolumeGroup.", + "pattern": "^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "VolumeNameParameter": { + "name": "volumeName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the Volume.", + "pattern": "^[a-z0-9]+(-[a-z0-9A-Z]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "type": "string", + "required": true, + "in": "path", + "description": "The name of the Private Endpoint connection.", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ElasticSanList": { + "type": "object", + "description": "List of Elastic Sans", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Elastic San objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ElasticSan" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticSan": { + "type": "object", + "description": "Response for ElasticSan request.", + "required": [ + "properties", + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of ElasticSan.", + "$ref": "#/definitions/ElasticSanProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticSanProperties": { + "type": "object", + "description": "Elastic San response properties.", + "required": [ + "baseSizeTiB", + "extendedCapacitySizeTiB", + "sku" + ], + "properties": { + "sku": { + "description": "resource sku", + "$ref": "#/definitions/Sku" + }, + "availabilityZones": { + "type": "array", + "description": "Logical zone for Elastic San resource; example: [\"1\"].", + "items": { + "$ref": "#/definitions/AvailabilityZone" + } + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "baseSizeTiB": { + "description": "Base size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedCapacitySizeTiB": { + "description": "Extended size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "totalVolumeSizeGiB": { + "description": "Total size of the provisioned Volumes in GiB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "volumeGroupCount": { + "description": "Total number of volume groups in this Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalIops": { + "description": "Total Provisioned IOPS of the Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalMBps": { + "description": "Total Provisioned MBps Elastic San appliance.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "totalSizeTiB": { + "description": "Total size of the Elastic San appliance in TB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint Connections." + } + } + }, + "ElasticSanUpdate": { + "type": "object", + "description": "Response for ElasticSan update request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of ElasticSan.", + "$ref": "#/definitions/ElasticSanUpdateProperties" + }, + "tags": { + "type": "object", + "description": "Update tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ElasticSanUpdateProperties": { + "type": "object", + "description": "Elastic San update properties.", + "properties": { + "baseSizeTiB": { + "description": "Base size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "extendedCapacitySizeTiB": { + "description": "Extended size of the Elastic San appliance in TiB.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AvailabilityZone": { + "type": "string", + "description": "Availability zone." + }, + "SkuInformationList": { + "description": "List of SKU Information objects", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "ElasticSAN SKU and its properties", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Sku Name", + "$ref": "#/definitions/SkuName" + }, + "tier": { + "type": "string", + "description": "Sku Tier", + "$ref": "#/definitions/SkuTier" + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "description": "Availability of the SKU for the location/zone", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "x-ms-identifiers": [], + "description": "The capability information in the specified SKU." + } + } + }, + "SKUCapability": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of capability." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "A string value to indicate states of given capability." + } + }, + "description": "The capability information in the specified SKU.", + "type": "object" + }, + "SkuLocationInfo": { + "description": "The location info.", + "type": "object", + "properties": { + "location": { + "description": "The location.", + "type": "string", + "readOnly": true + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName" + }, + "tier": { + "$ref": "#/definitions/SkuTier" + } + }, + "description": "The SKU name. Required for account creation; optional for update." + }, + "SkuName": { + "type": "string", + "enum": [ + "Premium_LRS", + "Premium_ZRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Premium_LRS", + "description": "Premium locally redundant storage" + }, + { + "value": "Premium_ZRS", + "description": "Premium zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "SkuTier": { + "type": "string", + "enum": [ + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Premium Tier" + } + ] + }, + "description": "The sku tier." + }, + "IscsiTargetInfo": { + "type": "object", + "description": "Iscsi target information", + "readOnly": true, + "properties": { + "targetIqn": { + "type": "string", + "description": "iSCSI Target IQN (iSCSI Qualified Name); example: \"iqn.2005-03.org.iscsi:server\".", + "readOnly": true + }, + "targetPortalHostname": { + "type": "string", + "description": "iSCSI Target Portal Host Name", + "readOnly": true + }, + "targetPortalPort": { + "type": "integer", + "format": "int32", + "description": "iSCSI Target Portal Port", + "readOnly": true + }, + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "status": { + "$ref": "#/definitions/OperationalStatus", + "description": "Operational status of the iSCSI Target." + } + } + }, + "VolumeGroup": { + "type": "object", + "description": "Response for Volume Group request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of VolumeGroup.", + "$ref": "#/definitions/VolumeGroupProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VolumeGroupList": { + "type": "object", + "description": "List of Volume Groups", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Volume Groups objects.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeGroup" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "VolumeGroupProperties": { + "type": "object", + "description": "VolumeGroup response properties.", + "properties": { + "provisioningState": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "protocolType": { + "description": "Type of storage target", + "$ref": "#/definitions/StorageTargetType" + }, + "encryption": { + "description": "Type of encryption", + "$ref": "#/definitions/EncryptionType" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of Private Endpoint Connections." + } + } + }, + "VolumeGroupUpdate": { + "type": "object", + "description": "Volume Group request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of VolumeGroup.", + "$ref": "#/definitions/VolumeGroupUpdateProperties" + } + } + }, + "VolumeGroupUpdateProperties": { + "type": "object", + "description": "VolumeGroup response properties.", + "properties": { + "protocolType": { + "description": "Type of storage target", + "$ref": "#/definitions/StorageTargetType" + }, + "encryption": { + "description": "Type of encryption", + "$ref": "#/definitions/EncryptionType" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "A collection of rules governing the accessibility from specific network locations.", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "Volume": { + "type": "object", + "description": "Response for Volume request.", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume.", + "$ref": "#/definitions/VolumeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "VolumeList": { + "type": "object", + "description": "List of Volumes", + "additionalProperties": false, + "properties": { + "value": { + "description": "An array of Volume objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + } + }, + "VolumeProperties": { + "type": "object", + "required": [ + "sizeGiB" + ], + "description": "Volume response properties.", + "properties": { + "volumeId": { + "description": "Unique Id of the volume in GUID format", + "type": "string", + "readOnly": true + }, + "creationData": { + "description": "State of the operation on the resource.", + "$ref": "#/definitions/SourceCreationData" + }, + "sizeGiB": { + "description": "Volume size.", + "type": "integer", + "format": "int64" + }, + "storageTarget": { + "description": "Storage target information", + "$ref": "#/definitions/IscsiTargetInfo" + } + } + }, + "VolumeUpdate": { + "type": "object", + "description": "Response for Volume request.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of Volume.", + "$ref": "#/definitions/VolumeUpdateProperties" + } + } + }, + "VolumeUpdateProperties": { + "type": "object", + "description": "Volume response properties.", + "properties": { + "sizeGiB": { + "description": "Volume size.", + "type": "integer", + "format": "int64" + } + } + }, + "SourceCreationData": { + "type": "object", + "description": "Data source used when creating the volume.", + "properties": { + "createSource": { + "type": "string", + "enum": [ + "None" + ], + "x-ms-enum": { + "name": "VolumeCreateOption", + "modelAsString": false + }, + "description": "This enumerates the possible sources of a volume creation." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point." + } + } + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Invalid", + "Succeeded", + "Failed", + "Canceled", + "Pending", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningStates", + "modelAsString": true + }, + "description": "Provisioning state of the iSCSI Target.", + "readOnly": true + }, + "OperationalStatus": { + "type": "string", + "enum": [ + "Invalid", + "Unknown", + "Healthy", + "Unhealthy", + "Updating", + "Running", + "Stopped", + "Stopped (deallocated)" + ], + "x-ms-enum": { + "name": "OperationalStatus", + "modelAsString": true + }, + "description": "Operational status of the resource." + }, + "StorageTargetType": { + "type": "string", + "enum": [ + "Iscsi", + "None" + ], + "x-ms-enum": { + "name": "StorageTargetType", + "modelAsString": true + }, + "description": "Storage Target type." + }, + "EncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Volume is encrypted at rest with Platform managed key. It is the default encryption type." + } + ] + } + }, + "NetworkRuleSet": { + "type": "object", + "properties": { + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The list of virtual network rules." + } + }, + "description": "A set of rules governing the network accessibility." + }, + "VirtualNetworkRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of virtual network rule." + }, + "state": { + "type": "string", + "readOnly": true, + "enum": [ + "provisioning", + "deprovisioning", + "succeeded", + "failed", + "networkSourceDeleted" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": false + }, + "description": "Gets the state of virtual network rule." + } + }, + "required": [ + "id" + ], + "description": "Virtual Network rule." + }, + "PrivateEndpointConnection": { + "type": "object", + "description": " Response for PrivateEndpoint Connection object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Private Endpoint Connection Properties.", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": " Response for PrivateEndpoint connection properties", + "properties": { + "provisioningState": { + "description": "Provisioning State of Private Endpoint connection resource", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "privateEndpoint": { + "description": "Private Endpoint resource", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Private Link Service Connection State.", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + }, + "groupIds": { + "description": " List of resources private endpoint is mapped", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Response for PrivateEndpoint", + "properties": { + "id": { + "type": "string", + "description": "The ARM identifier for Private Endpoint", + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "Response for Private Link Service Connection state", + "properties": { + "status": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus" + }, + "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." + } + } + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Failed", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + }, + "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/v3/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": { + "description": "URI to fetch the next section of the paginated response.", + "type": "string", + "readOnly": true + } + }, + "description": "List of private endpoint connections associated with SAN" + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8a541d41a87a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Create_MaximumSet_Gen.json @@ -0,0 +1,104 @@ +{ + "title": "ElasticSans_Create", + "operationId": "ElasticSans_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "baseSizeTiB": 5, + "extendedCapacitySizeTiB": 25 + }, + "tags": { + "key9316": "ihndtieqibtob" + }, + "location": "South Central US" + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27 + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Creating", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27 + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..2e2d74f5f223 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Create_MinimumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "ElasticSans_Create", + "operationId": "ElasticSans_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "sku": { + "name": "Premium_LRS" + }, + "baseSizeTiB": 5, + "extendedCapacitySizeTiB": 25 + }, + "location": "South Central US" + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27 + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Creating", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27 + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d8dbaedbfb24 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ElasticSans_Delete", + "operationId": "ElasticSans_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d8dbaedbfb24 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Delete_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "ElasticSans_Delete", + "operationId": "ElasticSans_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b219301153ac --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Get_MaximumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "ElasticSans_Get", + "operationId": "ElasticSans_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..b219301153ac --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Get_MinimumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "ElasticSans_Get", + "operationId": "ElasticSans_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b31c3234e38 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "ElasticSans_ListByResourceGroup", + "operationId": "ElasticSans_ListByResourceGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + ], + "nextLink": "goepspyylutlwudutmpi" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..0b31c3234e38 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "ElasticSans_ListByResourceGroup", + "operationId": "ElasticSans_ListByResourceGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + ], + "nextLink": "goepspyylutlwudutmpi" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..f048dcb61172 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "ElasticSans_ListBySubscription", + "operationId": "ElasticSans_ListBySubscription", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + ], + "nextLink": "goepspyylutlwudutmpi" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..f048dcb61172 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "ElasticSans_ListBySubscription", + "operationId": "ElasticSans_ListBySubscription", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + ], + "nextLink": "goepspyylutlwudutmpi" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..e35cee40e292 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Update_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "title": "ElasticSans_Update", + "operationId": "ElasticSans_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": { + "properties": { + "baseSizeTiB": 10, + "extendedCapacitySizeTiB": 22 + }, + "tags": { + "key4212": "cqvcnwfefljntgeio" + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..0a25b8820926 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/ElasticSans_Update_MinimumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "ElasticSans_Update", + "operationId": "ElasticSans_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "parameters": {}, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": { + "name": "Premium_LRS", + "tier": "Premium" + }, + "availabilityZones": [ + "1" + ], + "provisioningState": "Succeeded", + "baseSizeTiB": 15, + "extendedCapacitySizeTiB": 6, + "totalVolumeSizeGiB": 15, + "volumeGroupCount": 24, + "totalIops": 22, + "totalMBps": 4, + "totalSizeTiB": 27, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + }, + "tags": { + "key5002": "lhag" + }, + "location": "France Central", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}", + "name": "vfoatmakv", + "type": "Microsoft.ElasticSan/ElasticSans" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a5369bb6e747 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "qgcosclgjmglgs", + "isDataAction": true, + "display": { + "provider": "dbdmmszikohrwlvl", + "resource": "adqzzhgl", + "operation": "ofkypzumjbtezuqujudkqcf", + "description": "fmbdwtvxjilmflxdlmbysmr" + } + } + ], + "nextLink": "tfqrgvxkwqjx" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..e886002e0cb7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "qgcosclgjmglgs" + } + ] + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..adc3acdf5dc1 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,87 @@ +{ + "title": "PrivateEndpointConnections_Create", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "sytxzqlcoapcaywthgwvwcw" + ] + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..433208cc24ae --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Create_MinimumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "PrivateEndpointConnections_Create", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac49bca0a6bc --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "PrivateEndpoinConnections_Delete", + "operationId": "PrivateEndpoinConnections_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..ac49bca0a6bc --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "PrivateEndpoinConnections_Delete", + "operationId": "PrivateEndpoinConnections_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bfb3db7d956e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..bfb3db7d956e --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_Get_MinimumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "privateEndpointConnectionName": "privateendpointconnectionname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..c7c4f9d4edb7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_List_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_List", + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ], + "nextLink": "mwzcxnylrsniowju" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..c7c4f9d4edb7 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateEndpointConnections_List_MinimumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_List", + "operationId": "PrivateEndpointConnections_List", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ], + "nextLink": "mwzcxnylrsniowju" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json new file mode 100644 index 000000000000..3b86a1b2efda --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateLinkResources_ListByElasticSan_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResources_ListByElasticSan", + "operationId": "PrivateLinkResources_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "requiredMembers": [ + "{volumeGroupName}" + ], + "requiredZoneNames": [ + "lsknuvjjtgsrocmoq" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + } + } + ], + "nextLink": "qpcenviendbpjuhyzwzshdkd" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json new file mode 100644 index 000000000000..3b86a1b2efda --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/PrivateLinkResources_ListByElasticSan_MinimumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResources_ListByElasticSan", + "operationId": "PrivateLinkResources_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "requiredMembers": [ + "{volumeGroupName}" + ], + "requiredZoneNames": [ + "lsknuvjjtgsrocmoq" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + } + } + ], + "nextLink": "qpcenviendbpjuhyzwzshdkd" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Skus_List_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Skus_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..18e8a6ee91d4 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Skus_List_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2022-12-01-preview", + "$filter": "dtycml" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Premium_LRS", + "tier": "Premium", + "resourceType": "rnumsqm", + "locations": [ + "jqdpabrworxiinhlmfmtko" + ], + "locationInfo": [ + { + "location": "oxpkwgcdvlonfcwtttor", + "zones": [ + "1" + ] + } + ], + "capabilities": [ + { + "name": "fihkmeasrwpjyti", + "value": "jlojmjpjucekutlgtwhjgxwpqctdjy" + } + ] + } + ] + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Skus_List_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Skus_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..9188d9254cb1 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Skus_List_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "title": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": { + "subscriptionId": "subscriptionid", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..81f712ce37b4 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Create_MaximumSet_Gen.json @@ -0,0 +1,88 @@ +{ + "title": "VolumeGroups_Create", + "operationId": "VolumeGroups_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": { + "properties": { + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow" + } + ] + } + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..2f61de91e24c --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Create_MinimumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "VolumeGroups_Create", + "operationId": "VolumeGroups_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": {}, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d5334fbb71ff --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VolumeGroups_Delete", + "operationId": "VolumeGroups_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d5334fbb71ff --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "VolumeGroups_Delete", + "operationId": "VolumeGroups_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9dc109056fcf --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Get_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "VolumeGroups_Get", + "operationId": "VolumeGroups_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..9dc109056fcf --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Get_MinimumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "VolumeGroups_Get", + "operationId": "VolumeGroups_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json new file mode 100644 index 000000000000..b80109d0c451 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_ListByElasticSan_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "VolumeGroups_ListByElasticSan", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + ], + "nextLink": "bgcskeodhoozkjhfkkrdhnaxuroujc" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json new file mode 100644 index 000000000000..b80109d0c451 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_ListByElasticSan_MinimumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "VolumeGroups_ListByElasticSan", + "operationId": "VolumeGroups_ListByElasticSan", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + ], + "nextLink": "bgcskeodhoozkjhfkkrdhnaxuroujc" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..8d87a5b1bc84 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Update_MaximumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "title": "VolumeGroups_Update", + "operationId": "VolumeGroups_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": { + "properties": { + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow" + } + ] + } + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..6d4cd55a03ad --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/VolumeGroups_Update_MinimumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "VolumeGroups_Update", + "operationId": "VolumeGroups_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "parameters": {}, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Invalid", + "protocolType": "Iscsi", + "encryption": "EncryptionAtRestWithPlatformKey", + "networkAcls": { + "virtualNetworkRules": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}", + "action": "Allow", + "state": "provisioning" + } + ] + }, + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}" + ] + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.ElasticSan/elasticSans/privateEndpointConnections", + "systemData": { + "createdBy": "otfifnrahdshqombvtg", + "createdByType": "User", + "createdAt": "2023-07-03T09:59:45.919Z", + "lastModifiedBy": "jnaxavnlhrboshtidtib", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-03T09:59:45.919Z" + } + } + ] + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}", + "name": "cr", + "type": "Microsoft.ElasticSan/elasticSans/volumeGroups" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Create_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..ad7ca1245ab9 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Create_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "title": "Volumes_Create", + "operationId": "Volumes_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23 + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Creating", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Create_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Create_MinimumSet_Gen.json new file mode 100644 index 000000000000..86daa5986a42 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Create_MinimumSet_Gen.json @@ -0,0 +1,82 @@ +{ + "title": "Volumes_Create", + "operationId": "Volumes_Create", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "sizeGiB": 23 + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Creating", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e2a6b804eb93 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Delete_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Volumes_Delete", + "operationId": "Volumes_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..e2a6b804eb93 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Delete_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "title": "Volumes_Delete", + "operationId": "Volumes_Delete", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Get_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..defb27c24b1b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "Volumes_Get", + "operationId": "Volumes_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Get_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..defb27c24b1b --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Get_MinimumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "Volumes_Get", + "operationId": "Volumes_Get", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..e4d5447b3c25 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_ListByVolumeGroup_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "Volumes_ListByVolumeGroup", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + ], + "nextLink": "zrjgyuzmjvvatfujsbyrsxrudytm" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..e4d5447b3c25 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_ListByVolumeGroup_MinimumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "Volumes_ListByVolumeGroup", + "operationId": "Volumes_ListByVolumeGroup", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + ], + "nextLink": "zrjgyuzmjvvatfujsbyrsxrudytm" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Update_MaximumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..52429609d92a --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Update_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Volumes_Update", + "operationId": "Volumes_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": { + "properties": { + "sizeGiB": 11 + } + }, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Update_MinimumSet_Gen.json b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..f1f370f93de0 --- /dev/null +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/preview/2022-12-01-preview/examples/Volumes_Update_MinimumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "Volumes_Update", + "operationId": "Volumes_Update", + "parameters": { + "subscriptionId": "subscriptionid", + "resourceGroupName": "resourcegroupname", + "elasticSanName": "elasticsanname", + "volumeGroupName": "volumegroupname", + "volumeName": "volumename", + "parameters": {}, + "api-version": "2022-12-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "volumeId": "hkbhievbyopwjqawbyvqi", + "creationData": { + "createSource": "None", + "sourceUri": " ARM Id of resource" + }, + "sizeGiB": 23, + "storageTarget": { + "targetIqn": "yuuex", + "targetPortalHostname": "yktnmynpdjpmztwuwcvipp", + "targetPortalPort": 3, + "provisioningState": "Succeeded", + "status": "Invalid" + } + }, + "systemData": { + "createdBy": "zloujisrarsox", + "createdByType": "User", + "createdAt": "2023-07-04T05:52:15.371Z", + "lastModifiedBy": "lmdztjjcmdfzam", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-04T05:52:15.371Z" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}", + "name": "ipmipjggodoxjua", + "type": "Microsoft.ElasticSan/elasticSans" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/elasticsan/resource-manager/readme.md b/specification/elasticsan/resource-manager/readme.md index fb8f1a2c9dfc..866eeccaeb46 100644 --- a/specification/elasticsan/resource-manager/readme.md +++ b/specification/elasticsan/resource-manager/readme.md @@ -24,16 +24,25 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the storagepool. -```yaml +``` yaml openapi-type: arm -tag: package-2021-11-20-preview +tag: package-preview-2022-12 ``` + +### Tag: package-preview-2022-12 + +These settings apply only when `--tag=package-preview-2022-12` is specified on the command line. + +```yaml $(tag) == 'package-preview-2022-12' +input-file: + - Microsoft.ElasticSan/preview/2022-12-01-preview/elasticsan.json +``` ### Tag: package-2021-11-20-preview These settings apply only when `--tag=package-2021-11-20-preview` is specified on the command line. -```yaml $(tag) == 'package-2021-11-20-preview' +``` yaml $(tag) == 'package-2021-11-20-preview' input-file: - Microsoft.ElasticSan/preview/2021-11-20-preview/elasticsan.json ``` @@ -47,7 +56,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-net-track2 - repo: azure-sdk-for-python-track2 diff --git a/specification/elasticsan/resource-manager/readme.python.md b/specification/elasticsan/resource-manager/readme.python.md index 65618da54512..e79873f42beb 100644 --- a/specification/elasticsan/resource-manager/readme.python.md +++ b/specification/elasticsan/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: ElasticSanMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-elasticsan diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json index 85f85b5de180..b378a3e5b0a6 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json @@ -42,8 +42,8 @@ "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", - "in": "header", - "name": "SharedAccessKey" + "name": "SharedAccessKey", + "in": "header" } }, "tags": [], @@ -52,6 +52,9 @@ "post": { "operationId": "PublishCloudEvents", "description": "Publish Batch Cloud Event to namespace topic. In case of success, the server responds with an HTTP 200 status code with an empty JSON object in response. Otherwise, the server can return various error codes. For example, 401: which indicates authorization failure, 403: which indicates quota exceeded or message is too large, 410: which indicates that specific topic is not found, 400: for bad request, and 500: for internal server error. ", + "consumes": [ + "application/cloudevents-batch+json; charset=utf-8" + ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" @@ -59,21 +62,20 @@ { "name": "topicName", "in": "path", - "required": true, "description": "Topic Name.", + "required": true, "type": "string" }, { "name": "events", "in": "body", - "required": true, "description": "Array of Cloud Events being published.", + "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/CloudEvent" - }, - "x-typespec-name": "CloudEvent[]" + } } } ], @@ -86,20 +88,17 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, - "consumes": [ - "application/cloudevents-batch+json; charset=utf-8" - ], "x-ms-examples": { "Publish Cloud Event": { "$ref": "./examples/publish.json" @@ -118,33 +117,33 @@ { "name": "topicName", "in": "path", - "required": true, "description": "Topic Name.", + "required": true, "type": "string" }, { "name": "eventSubscriptionName", "in": "path", - "required": true, "description": "Event Subscription Name.", + "required": true, "type": "string" }, { "name": "maxEvents", "in": "query", - "required": false, "description": "Max Events count to be received. Minimum value is 1, while maximum value is 100 events. If not specified, the default value is 1.", - "default": 1, + "required": false, "type": "integer", "format": "int32", + "default": 1, "minimum": 1, "maximum": 100 }, { "name": "maxWaitTime", "in": "query", - "required": false, "description": "Max wait time value for receive operation in Seconds. It is the time in seconds that the server approximately waits for the availability of an event and responds to the request. If an event is available, the broker responds immediately to the client. Minimum value is 10 seconds, while maximum value is 120 seconds. If not specified, the default value is 60 seconds.", + "required": false, "type": "integer", "format": "int32" } @@ -158,14 +157,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -187,22 +186,22 @@ { "name": "topicName", "in": "path", - "required": true, "description": "Topic Name.", + "required": true, "type": "string" }, { "name": "eventSubscriptionName", "in": "path", - "required": true, "description": "Event Subscription Name.", + "required": true, "type": "string" }, { "name": "lockTokens", "in": "body", - "required": true, "description": "AcknowledgeOptions.", + "required": true, "schema": { "$ref": "#/definitions/AcknowledgeOptions" } @@ -217,14 +216,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -246,22 +245,22 @@ { "name": "topicName", "in": "path", - "required": true, "description": "Topic Name.", + "required": true, "type": "string" }, { "name": "eventSubscriptionName", "in": "path", - "required": true, "description": "Event Subscription Name.", + "required": true, "type": "string" }, { "name": "lockTokens", "in": "body", - "required": true, "description": "ReleaseOptions", + "required": true, "schema": { "$ref": "#/definitions/ReleaseOptions" } @@ -276,14 +275,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -305,22 +304,22 @@ { "name": "topicName", "in": "path", - "required": true, "description": "Topic Name.", + "required": true, "type": "string" }, { "name": "eventSubscriptionName", "in": "path", - "required": true, "description": "Event Subscription Name.", + "required": true, "type": "string" }, { "name": "lockTokens", "in": "body", - "required": true, "description": "RejectOptions", + "required": true, "schema": { "$ref": "#/definitions/RejectOptions" } @@ -335,14 +334,14 @@ }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, "headers": { "x-ms-error-code": { "description": "String error code indicating what went wrong.", "type": "string" } - }, - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" } } }, @@ -357,43 +356,40 @@ "definitions": { "AcknowledgeOptions": { "type": "object", + "description": "Array of lock token strings for the corresponding received Cloud Events to be acknowledged.", "properties": { "lockTokens": { "type": "array", + "description": "String array of lock tokens.", "items": { "type": "string" - }, - "description": "String array of lock tokens.", - "x-typespec-name": "string[]" + } } }, - "description": "Array of lock token strings for the corresponding received Cloud Events to be acknowledged.", "required": [ "lockTokens" ] }, "AcknowledgeResult": { "type": "object", + "description": "The result of the Acknowledge operation.", "properties": { "failedLockTokens": { "type": "array", + "description": "Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description).", "items": { "$ref": "#/definitions/FailedLockToken" }, - "x-ms-identifiers": [], - "description": "Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description).", - "x-typespec-name": "FailedLockToken[]" + "x-ms-identifiers": [] }, "succeededLockTokens": { "type": "array", + "description": "Array of lock tokens values for the successfully acknowledged cloud events.", "items": { "type": "string" - }, - "description": "Array of lock tokens values for the successfully acknowledged cloud events.", - "x-typespec-name": "string[]" + } } }, - "description": "The result of the Acknowledge operation.", "required": [ "failedLockTokens", "succeededLockTokens" @@ -401,6 +397,7 @@ }, "Azure.Core.Foundations.Error": { "type": "object", + "description": "The error object.", "properties": { "code": { "type": "string", @@ -416,19 +413,17 @@ }, "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": [], - "description": "An array of details about specific errors that led to this reported error.", - "x-typespec-name": "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." } }, - "description": "The error object.", "required": [ "code", "message" @@ -436,19 +431,20 @@ }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", + "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, - "description": "A response containing error details.", "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", + "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", @@ -458,11 +454,11 @@ "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } - }, - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses." + } }, "BrokerProperties": { "type": "object", + "description": "Properties of the Event Broker operation.", "properties": { "lockToken": { "type": "string", @@ -474,7 +470,6 @@ "description": "The attempt count for delivering the event." } }, - "description": "Properties of the Event Broker operation.", "required": [ "lockToken", "deliveryCount" @@ -482,6 +477,7 @@ }, "CloudEvent": { "type": "object", + "description": "Properties of an event published to an Azure Messaging EventGrid Namespace topic using the CloudEvent 1.0 Schema.", "properties": { "id": { "type": "string", @@ -525,7 +521,6 @@ "description": "This describes the subject of the event in the context of the event producer (identified by source)." } }, - "description": "Properties of an event published to an Azure Messaging EventGrid Namespace topic using the CloudEvent 1.0 Schema.", "required": [ "id", "source", @@ -535,6 +530,7 @@ }, "FailedLockToken": { "type": "object", + "description": "Failed LockToken information.", "properties": { "lockToken": { "type": "string", @@ -549,7 +545,6 @@ "description": "Description of the token error." } }, - "description": "Failed LockToken information.", "required": [ "lockToken", "errorCode", @@ -558,11 +553,12 @@ }, "PublishResult": { "type": "object", - "properties": {}, - "description": "The result of the Publish operation." + "description": "The result of the Publish operation.", + "properties": {} }, "ReceiveDetails": { "type": "object", + "description": "Receive operation details per Cloud Event.", "properties": { "brokerProperties": { "$ref": "#/definitions/BrokerProperties", @@ -573,7 +569,6 @@ "description": "Cloud Event details." } }, - "description": "Receive operation details per Cloud Event.", "required": [ "brokerProperties", "event" @@ -581,61 +576,57 @@ }, "ReceiveResult": { "type": "object", + "description": "Details of the Receive operation response.", "properties": { "value": { "type": "array", + "description": "Array of receive responses, one per cloud event.", "items": { "$ref": "#/definitions/ReceiveDetails" }, - "x-ms-identifiers": [], - "description": "Array of receive responses, one per cloud event.", - "x-typespec-name": "ReceiveDetails[]" + "x-ms-identifiers": [] } }, - "description": "Details of the Receive operation response.", "required": [ "value" ] }, "RejectOptions": { "type": "object", + "description": "Array of lock token strings for the corresponding received Cloud Events to be rejected.", "properties": { "lockTokens": { "type": "array", + "description": "String array of lock tokens.", "items": { "type": "string" - }, - "description": "String array of lock tokens.", - "x-typespec-name": "string[]" + } } }, - "description": "Array of lock token strings for the corresponding received Cloud Events to be rejected.", "required": [ "lockTokens" ] }, "RejectResult": { "type": "object", + "description": "The result of the Reject operation.", "properties": { "failedLockTokens": { "type": "array", + "description": "Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description).", "items": { "$ref": "#/definitions/FailedLockToken" }, - "x-ms-identifiers": [], - "description": "Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description).", - "x-typespec-name": "FailedLockToken[]" + "x-ms-identifiers": [] }, "succeededLockTokens": { "type": "array", + "description": "Array of lock tokens values for the successfully rejected cloud events.", "items": { "type": "string" - }, - "description": "Array of lock tokens values for the successfully rejected cloud events.", - "x-typespec-name": "string[]" + } } }, - "description": "The result of the Reject operation.", "required": [ "failedLockTokens", "succeededLockTokens" @@ -643,43 +634,40 @@ }, "ReleaseOptions": { "type": "object", + "description": "Array of lock token strings for the corresponding received Cloud Events to be released.", "properties": { "lockTokens": { "type": "array", + "description": "String array of lock tokens.", "items": { "type": "string" - }, - "description": "String array of lock tokens.", - "x-typespec-name": "string[]" + } } }, - "description": "Array of lock token strings for the corresponding received Cloud Events to be released.", "required": [ "lockTokens" ] }, "ReleaseResult": { "type": "object", + "description": "The result of the Release operation.", "properties": { "failedLockTokens": { "type": "array", + "description": "Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description).", "items": { "$ref": "#/definitions/FailedLockToken" }, - "x-ms-identifiers": [], - "description": "Array of LockToken values for failed cloud events. Each LockToken includes the lock token value along with the related error information (namely, the error code and description).", - "x-typespec-name": "FailedLockToken[]" + "x-ms-identifiers": [] }, "succeededLockTokens": { "type": "array", + "description": "Array of lock tokens values for the successfully released cloud events.", "items": { "type": "string" - }, - "description": "Array of lock tokens values for the successfully released cloud events.", - "x-typespec-name": "string[]" + } } }, - "description": "The result of the Release operation.", "required": [ "failedLockTokens", "succeededLockTokens" @@ -690,12 +678,12 @@ "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", - "required": true, "description": "The API version to use for this operation.", - "x-ms-client-name": "apiVersion", + "required": true, "type": "string", "minLength": 1, - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" } } } diff --git a/specification/fist/resource-manager/readme.java.md b/specification/fist/resource-manager/readme.java.md new file mode 100644 index 000000000000..81a1f8b639a8 --- /dev/null +++ b/specification/fist/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +```yaml $(java) +service-name: IoT Firmware Defense +``` diff --git a/specification/fist/resource-manager/readme.md b/specification/fist/resource-manager/readme.md index 72d98965866b..4316749e1cde 100644 --- a/specification/fist/resource-manager/readme.md +++ b/specification/fist/resource-manager/readme.md @@ -81,3 +81,7 @@ 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/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json new file mode 100644 index 000000000000..f1763aea03eb --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json @@ -0,0 +1,3034 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01", + "title": "MaintenanceManagementClient", + "description": "Azure Maintenance Management Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations": { + "get": { + "tags": [ + "PublicMaintenanceConfigurations" + ], + "summary": "Get Public Maintenance Configuration records", + "operationId": "PublicMaintenanceConfigurations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "PublicMaintenanceConfigurations_List": { + "$ref": "./examples/PublicMaintenanceConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}": { + "get": { + "tags": [ + "PublicMaintenanceConfigurations" + ], + "summary": "Get Public Maintenance Configuration record", + "operationId": "PublicMaintenanceConfigurations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "PublicMaintenanceConfigurations_GetForResource": { + "$ref": "./examples/PublicMaintenanceConfigurations_GetForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { + "get": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Track Updates to resource with parent", + "description": "Track maintenance updates to resource with parent", + "operationId": "ApplyUpdates_GetParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "applyUpdateName", + "in": "path", + "description": "applyUpdate Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_GetParent": { + "$ref": "./examples/ApplyUpdates_GetParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { + "get": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Track Updates to resource", + "description": "Track maintenance updates to resource", + "operationId": "ApplyUpdates_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "applyUpdateName", + "in": "path", + "description": "applyUpdate Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_Get": { + "$ref": "./examples/ApplyUpdates_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default": { + "put": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Apply Updates to resource with parent", + "description": "Apply maintenance updates to resource with parent", + "operationId": "ApplyUpdates_CreateOrUpdateParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Apply-update update request accepted", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "201": { + "description": "Apply-update create request accepted", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_CreateOrUpdateParent": { + "$ref": "./examples/ApplyUpdates_CreateOrUpdateParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default": { + "put": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Apply Updates to resource", + "description": "Apply maintenance updates to resource", + "operationId": "ApplyUpdates_CreateOrUpdate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ApplyUpdate update request accepted", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "201": { + "description": "ApplyUpdate create request accepted", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_CreateOrUpdate": { + "$ref": "./examples/ApplyUpdates_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignments_GetParent", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_GetParent": { + "$ref": "./examples/ConfigurationAssignments_GetParent.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignments_CreateOrUpdateParent", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Configuration assignment update request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_CreateOrUpdateParent": { + "$ref": "./examples/ConfigurationAssignments_CreateOrUpdateParent.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignments_DeleteParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_DeleteParent": { + "$ref": "./examples/ConfigurationAssignments_DeleteParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignments_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_Get": { + "$ref": "./examples/ConfigurationAssignments_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Configuration assignment update request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignments_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_Delete": { + "$ref": "./examples/ConfigurationAssignments_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "List configurationAssignments for resource", + "description": "List configurationAssignments for resource.", + "operationId": "ConfigurationAssignments_ListParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListConfigurationAssignmentsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ConfigurationAssignments_ListParent": { + "$ref": "./examples/ConfigurationAssignments_ListParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "List configurationAssignments for resource", + "description": "List configurationAssignments for resource.", + "operationId": "ConfigurationAssignments_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListConfigurationAssignmentsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ConfigurationAssignments_List": { + "$ref": "./examples/ConfigurationAssignments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Get Configuration record", + "operationId": "MaintenanceConfigurations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_GetForResource": { + "$ref": "./examples/MaintenanceConfigurations_GetForResource.json" + }, + "MaintenanceConfigurations_GetForResource_GuestOSPatchWindows": { + "$ref": "./examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json" + }, + "MaintenanceConfigurations_GetForResource_GuestOSPatchLinux": { + "$ref": "./examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Create or Update configuration record", + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "name": "configuration", + "in": "body", + "description": "The configuration", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Maintenance configuration update request accepted", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "Maintenance configuration create request accepted", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_CreateOrUpdateForResource": { + "$ref": "./examples/MaintenanceConfigurations_CreateOrUpdateForResource.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Delete Configuration record", + "operationId": "MaintenanceConfigurations_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_DeleteForResource": { + "$ref": "./examples/MaintenanceConfigurations_DeleteForResource.json" + } + } + }, + "patch": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Patch configuration record", + "operationId": "MaintenanceConfigurations_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "name": "configuration", + "in": "body", + "description": "The configuration", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_UpdateForResource": { + "$ref": "./examples/MaintenanceConfigurations_UpdateForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Get Configuration records within a subscription", + "operationId": "MaintenanceConfigurations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "MaintenanceConfigurations_List": { + "$ref": "./examples/MaintenanceConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Get Configuration records within a subscription and resource group", + "operationId": "MaintenanceConfigurationsForResourceGroup_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "MaintenanceConfigurationsResourceGroup_List": { + "$ref": "./examples/MaintenanceConfigurationsResourceGroup_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates": { + "get": { + "tags": [ + "ApplyUpdate" + ], + "summary": "Get Configuration records within a subscription", + "operationId": "ApplyUpdates_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ApplyUpdates_List": { + "$ref": "./examples/ApplyUpdates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates": { + "get": { + "tags": [ + "ApplyUpdate" + ], + "summary": "Get Configuration records within a subscription and resource group", + "operationId": "ApplyUpdateForResourceGroup_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ApplyUpdatesResourceGroup_List": { + "$ref": "./examples/ApplyUpdatesResourceGroup_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment within a subscription", + "operationId": "ConfigurationAssignmentsWithinSubscription_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListConfigurationAssignmentsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ConfigurationAssignmentsResultWithinSubscription_List": { + "$ref": "./examples/ConfigurationAssignmentsResultWithinSubscription_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignmentsForSubscriptions_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_GetParent": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Configuration assignment update request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignmentsForSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForSubscriptions_Delete": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignmentsForResourceGroup_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string", + "pattern": "^.+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_Get": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Configuration assignment update request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForResourceGroup_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignmentsForResourceGroup_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_Delete": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_Delete.json" + } + } + } + }, + "/providers/Microsoft.Maintenance/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List available operations", + "description": "List the available operations supported by the Microsoft.Maintenance resource provider", + "operationId": "Operations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates": { + "get": { + "tags": [ + "Updates" + ], + "summary": "Get Updates to resource", + "description": "Get updates to resources.", + "operationId": "Updates_ListParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUpdatesResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Updates_ListParent": { + "$ref": "./examples/Updates_ListParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates": { + "get": { + "tags": [ + "Updates" + ], + "summary": "Get Updates to resource", + "description": "Get updates to resources.", + "operationId": "Updates_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUpdatesResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Updates_List": { + "$ref": "./examples/Updates_List.json" + } + } + } + } + }, + "definitions": { + "ApplyUpdateProperties": { + "description": "Properties for apply update", + "type": "object", + "properties": { + "status": { + "description": "The status", + "enum": [ + "Pending", + "InProgress", + "Completed", + "RetryNow", + "RetryLater" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "description": "There are pending updates to be installed." + }, + { + "value": "InProgress", + "description": "Updates installation are in progress." + }, + { + "value": "Completed", + "description": "All updates are successfully applied." + }, + { + "value": "RetryNow", + "description": "Updates installation failed but are ready to retry again." + }, + { + "value": "RetryLater", + "description": "Updates installation failed and should be retried later." + } + ] + } + }, + "resourceId": { + "description": "The resourceId", + "type": "string" + }, + "lastUpdateTime": { + "format": "date-time", + "description": "Last Update time", + "type": "string" + } + } + }, + "Resource": { + "description": "Definition of a Resource", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource", + "type": "string", + "readOnly": true + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "ApplyUpdate": { + "description": "Apply Update request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplyUpdateProperties", + "description": "Properties of the apply update", + "x-ms-client-flatten": true + } + } + }, + "ListApplyUpdate": { + "description": "Response for ApplyUpdate list", + "type": "object", + "properties": { + "value": { + "description": "The list of apply updates", + "type": "array", + "items": { + "$ref": "#/definitions/ApplyUpdate" + } + } + } + }, + "ConfigurationAssignmentFilterProperties": { + "type": "object", + "description": "Azure query for the update configuration.", + "properties": { + "resourceTypes": { + "type": "array", + "description": "List of allowed resources.", + "items": { + "type": "string", + "description": "List of allowed resources" + } + }, + "resourceGroups": { + "type": "array", + "description": "List of allowed resource groups.", + "items": { + "type": "string", + "description": "List of allowed resource groups" + } + }, + "osTypes": { + "type": "array", + "description": "List of allowed operating systems.", + "items": { + "type": "string", + "description": "List of allowed operating systems" + } + }, + "locations": { + "type": "array", + "description": "List of locations to scope the query to.", + "items": { + "type": "string", + "description": "Location to scope the query to." + } + }, + "tagSettings": { + "type": "object", + "description": "Tag settings for the VM.", + "$ref": "#/definitions/TagSettingsProperties" + } + } + }, + "TagSettingsProperties": { + "type": "object", + "description": "Tag filter information for the VM.", + "properties": { + "tags": { + "type": "object", + "description": "Dictionary of tags with its list of values.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "List of tag values for a tag." + } + } + }, + "filterOperator": { + "type": "string", + "description": "Filter VMs by Any or All specified tags.", + "enum": [ + "All", + "Any" + ], + "x-ms-enum": { + "name": "TagOperators", + "modelAsString": false + } + } + } + }, + "ConfigurationAssignmentProperties": { + "description": "Properties for configuration assignment", + "type": "object", + "properties": { + "maintenanceConfigurationId": { + "description": "The maintenance configuration Id", + "type": "string" + }, + "resourceId": { + "description": "The unique resourceId", + "type": "string" + }, + "filter": { + "$ref": "#/definitions/ConfigurationAssignmentFilterProperties", + "description": "Properties of the configuration assignment" + } + } + }, + "ConfigurationAssignment": { + "description": "Configuration Assignment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Location of the resource", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ConfigurationAssignmentProperties", + "description": "Properties of the configuration assignment", + "x-ms-client-flatten": true + } + } + }, + "ListConfigurationAssignmentsResult": { + "description": "Response for ConfigurationAssignments list", + "type": "object", + "properties": { + "value": { + "description": "The list of configuration Assignments", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationAssignment" + } + } + } + }, + "MaintenanceWindow": { + "description": "Definition of a MaintenanceWindow", + "type": "object", + "properties": { + "startDateTime": { + "description": "Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.", + "type": "string" + }, + "expirationDateTime": { + "description": "Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.", + "type": "string" + }, + "duration": { + "description": "Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00.", + "type": "string" + }, + "timeZone": { + "description": "Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time.", + "type": "string" + }, + "recurEvery": { + "description": "Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.", + "type": "string" + } + } + }, + "MaintenanceConfigurationProperties": { + "description": "Properties for maintenance configuration", + "type": "object", + "properties": { + "namespace": { + "description": "Gets or sets namespace of the resource", + "type": "string" + }, + "extensionProperties": { + "description": "Gets or sets extensionProperties of the maintenanceConfiguration", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "maintenanceScope": { + "description": "Gets or sets maintenanceScope of the configuration", + "enum": [ + "Host", + "Resource", + "OSImage", + "Extension", + "InGuestPatch", + "SQLDB", + "SQLManagedInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "MaintenanceScope", + "modelAsString": true, + "values": [ + { + "value": "Host", + "description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs." + }, + { + "value": "Resource", + "description": "This maintenance scope controls the default update maintenance of the Azure Resource" + }, + { + "value": "OSImage", + "description": "This maintenance scope controls os image installation on VM/VMSS" + }, + { + "value": "Extension", + "description": "This maintenance scope controls extension installation on VM/VMSS" + }, + { + "value": "InGuestPatch", + "description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS" + }, + { + "value": "SQLDB", + "description": "This maintenance scope controls installation of SQL server platform updates." + }, + { + "value": "SQLManagedInstance", + "description": "This maintenance scope controls installation of SQL managed instance platform update." + } + ] + } + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Definition of a MaintenanceWindow", + "x-ms-client-flatten": true + }, + "visibility": { + "description": "Gets or sets the visibility of the configuration. The default value is 'Custom'", + "enum": [ + "Custom", + "Public" + ], + "type": "string", + "x-ms-enum": { + "name": "Visibility", + "modelAsString": true, + "values": [ + { + "value": "Custom", + "description": "Only visible to users with permissions." + }, + { + "value": "Public", + "description": "Visible to all users." + } + ] + } + }, + "installPatches": { + "$ref": "#/definitions/InputPatchConfiguration", + "description": "The input parameters to be passed to the patch run operation." + } + } + }, + "InputPatchConfiguration": { + "type": "object", + "properties": { + "rebootSetting": { + "type": "string", + "enum": [ + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "RebootOptions", + "modelAsString": true + }, + "default": "IfRequired", + "description": "Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed." + }, + "windowsParameters": { + "$ref": "#/definitions/InputWindowsParameters", + "description": "Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property." + }, + "linuxParameters": { + "$ref": "#/definitions/InputLinuxParameters", + "description": "Input parameters specific to patching Linux machine. For Windows machines, do not pass this property." + } + }, + "description": "Input configuration for a patch run" + }, + "InputWindowsParameters": { + "type": "object", + "properties": { + "kbNumbersToExclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Windows KBID to be excluded for patching." + }, + "kbNumbersToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Windows KBID to be included for patching." + }, + "classificationsToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Classification category of patches to be patched" + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Exclude patches which need reboot" + } + }, + "description": "Input properties for patching a Windows machine." + }, + "InputLinuxParameters": { + "type": "object", + "properties": { + "packageNameMasksToExclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Package names to be excluded for patching." + }, + "packageNameMasksToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Package names to be included for patching." + }, + "classificationsToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Classification category of patches to be patched" + } + }, + "description": "Input properties for patching a Linux machine." + }, + "MaintenanceConfiguration": { + "description": "Maintenance configuration record type", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Gets or sets location of the resource", + "type": "string" + }, + "tags": { + "description": "Gets or sets tags of the resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "description": "Gets or sets properties of the resource", + "x-ms-client-flatten": true + } + } + }, + "MaintenanceError": { + "description": "An error response received from the Azure Maintenance service.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetails", + "description": "Details of the error" + } + } + }, + "ErrorDetails": { + "description": "An error response details received from the Azure Maintenance service.", + "type": "object", + "properties": { + "code": { + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.", + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "type": "string" + } + } + }, + "ListMaintenanceConfigurationsResult": { + "description": "Response for MaintenanceConfigurations list", + "type": "object", + "properties": { + "value": { + "description": "The list of maintenance Configurations", + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + } + } + }, + "OperationsListResult": { + "description": "Result of the List Operations operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Operation": { + "description": "Represents an operation returned by the GetOperations request", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationInfo", + "description": "Display name of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationInfo": { + "description": "Information about an operation", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider", + "type": "string" + }, + "resource": { + "description": "Name of the resource type", + "type": "string" + }, + "operation": { + "description": "Name of the operation", + "type": "string" + }, + "description": { + "description": "Description of the operation", + "type": "string" + } + } + }, + "ListUpdatesResult": { + "description": "Response for Updates list", + "type": "object", + "properties": { + "value": { + "description": "The pending updates", + "type": "array", + "items": { + "$ref": "#/definitions/Update" + }, + "x-ms-identifiers": [] + } + } + }, + "Update": { + "description": "Maintenance update on a resource", + "type": "object", + "properties": { + "maintenanceScope": { + "description": "The impact area", + "enum": [ + "Host", + "Resource", + "OSImage", + "Extension", + "InGuestPatch", + "SQLDB", + "SQLManagedInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "MaintenanceScope", + "modelAsString": true, + "values": [ + { + "value": "Host", + "description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs." + }, + { + "value": "Resource", + "description": "This maintenance scope controls the default update maintenance of the Azure Resource" + }, + { + "value": "OSImage", + "description": "This maintenance scope controls os image installation on VM/VMSS" + }, + { + "value": "Extension", + "description": "This maintenance scope controls extension installation on VM/VMSS" + }, + { + "value": "InGuestPatch", + "description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS" + }, + { + "value": "SQLDB", + "description": "This maintenance scope controls installation of SQL server platform updates." + }, + { + "value": "SQLManagedInstance", + "description": "This maintenance scope controls installation of SQL managed instance platform update." + } + ] + } + }, + "impactType": { + "description": "The impact type", + "enum": [ + "None", + "Freeze", + "Restart", + "Redeploy" + ], + "type": "string", + "x-ms-enum": { + "name": "ImpactType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Pending updates has no impact on resource." + }, + { + "value": "Freeze", + "description": "Pending updates can freeze network or disk io operation on resource." + }, + { + "value": "Restart", + "description": "Pending updates can cause resource to restart." + }, + { + "value": "Redeploy", + "description": "Pending updates can redeploy resource." + } + ] + } + }, + "status": { + "description": "The status", + "enum": [ + "Pending", + "InProgress", + "Completed", + "RetryNow", + "RetryLater" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "description": "There are pending updates to be installed." + }, + { + "value": "InProgress", + "description": "Updates installation are in progress." + }, + { + "value": "Completed", + "description": "All updates are successfully applied." + }, + { + "value": "RetryNow", + "description": "Updates installation failed but are ready to retry again." + }, + { + "value": "RetryLater", + "description": "Updates installation failed and should be retried later." + } + ] + } + }, + "impactDurationInSec": { + "format": "int32", + "description": "Duration of impact in seconds", + "type": "integer" + }, + "notBefore": { + "format": "date-time", + "description": "Time when Azure will start force updates if not self-updated by customer before this time", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/UpdateProperties", + "description": "Properties of the apply update", + "x-ms-client-flatten": true + } + } + }, + "UpdateProperties": { + "description": "Properties for update", + "type": "object", + "properties": { + "resourceId": { + "description": "The resourceId", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of the API to be used with the client request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json new file mode 100644 index 000000000000..cd68c3164dd9 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Maintenance", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Completed" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json new file mode 100644 index 000000000000..033b3b9c6c46 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Pending" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Pending" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json new file mode 100644 index 000000000000..a001eb591eda --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", + "status": "Pending" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", + "status": "Pending" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json new file mode 100644 index 000000000000..d09ac9b2d231 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "applyUpdateName": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Completed" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json new file mode 100644 index 000000000000..b1b99728c9c5 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "applyUpdateName": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", + "status": "Completed" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json new file mode 100644 index 000000000000..063401144973 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "providerName": "Microsoft.Maintenance", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Completed" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json new file mode 100644 index 000000000000..2734f84cedf5 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "osTypes": [ + "Windows", + "Linux" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json new file mode 100644 index 000000000000..269edc997f02 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json new file mode 100644 index 000000000000..b1e6d6dd32f3 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json new file mode 100644 index 000000000000..cb3f11dabc9c --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..eb829877dc09 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json new file mode 100644 index 000000000000..fa8610c3c11c --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json new file mode 100644 index 000000000000..e967df973f8e --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json new file mode 100644 index 000000000000..466240c709cc --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json new file mode 100644 index 000000000000..4d8553b74212 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "providerName": "Microsoft.Maintenance", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json new file mode 100644 index 000000000000..e1a48bb1df9a --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json new file mode 100644 index 000000000000..90379b5f9355 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "configurationAssignmentName": "workervmPolicy", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json new file mode 100644 index 000000000000..a85db48b8f6b --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json new file mode 100644 index 000000000000..b908aac66f4b --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json new file mode 100644 index 000000000000..901fd7a6c61c --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json new file mode 100644 index 000000000000..f86089fa0766 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "configurationAssignmentName": "workervmPolicy", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json new file mode 100644 index 000000000000..6f04597d4763 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json new file mode 100644 index 000000000000..7a21a5852970 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdtestvm1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdtestvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdtestvm1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json new file mode 100644 index 000000000000..7f19b3dff9ab --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json new file mode 100644 index 000000000000..101c9375b0cf --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01", + "configuration": { + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Day" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Day" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Day" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json new file mode 100644 index 000000000000..b542151adb94 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "example1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance" + } + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json new file mode 100644 index 000000000000..469d307bcf79 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "5Days" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json new file mode 100644 index 000000000000..cb34ac5c9869 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "InGuestPatch", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "5Days" + }, + "installPatches": { + "linuxParameters": { + "classificationsToInclude": [ + "Critical" + ], + "packageNameMasksToExclude": [ + "apt", + "http" + ], + "packageNameMasksToInclude": [ + "binutils", + "bin" + ] + }, + "rebootSetting": "Always" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json new file mode 100644 index 000000000000..381f3a0f9eef --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "InGuestPatch", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "5Days" + }, + "installPatches": { + "windowsParameters": { + "classificationsToInclude": [ + "Security" + ], + "kbNumbersToInclude": [ + "KB123456" + ], + "kbNumbersToExclude": [ + "KB234567" + ], + "excludeKbsRequiringReboot": false + }, + "rebootSetting": "Always" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json new file mode 100644 index 000000000000..d05c74071df8 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json new file mode 100644 index 000000000000..e9055dfafa0d --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01", + "configuration": { + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Month Third Sunday" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Month Third Sunday" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json new file mode 100644 index 000000000000..77c3ae6d7e29 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json new file mode 100644 index 000000000000..03b7d9387f4a --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "SQLDB", + "visibility": "Public", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "2Weeks" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json new file mode 100644 index 000000000000..9582630da1ca --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "SQLDB", + "visibility": "Public", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00:00", + "expirationDateTime": "9999-12-31 00:00:00", + "duration": "05:00:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json new file mode 100644 index 000000000000..47d012abf1f6 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "maintenanceScope": "Resource", + "status": "Pending", + "impactType": "Reboot", + "impactDurationInSec": 1440, + "notBefore": "2018-10-09T06:17:44.235Z", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json new file mode 100644 index 000000000000..803de75968f0 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "maintenanceScope": "Resource", + "status": "Pending", + "impactType": "Reboot", + "impactDurationInSec": 1440, + "notBefore": "2018-10-09T06:17:44.235Z", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/readme.cli.md b/specification/maintenance/resource-manager/readme.cli.md index 0327c7451143..784dfcef420a 100644 --- a/specification/maintenance/resource-manager/readme.cli.md +++ b/specification/maintenance/resource-manager/readme.cli.md @@ -6,4 +6,61 @@ These settings apply only when `--cli` is specified on the command line. cli: namespace: azure.mgmt.maintenance flatten-all: true + cli-directive: + - select: 'operationGroup' + where: + operationGroup: 'ApplyUpdateForResourceGroup' + hidden: true + - where: + operationGroup: 'MaintenanceConfigurationsForResourceGroup' + hidden: true + - where: + operationGroup: 'ConfigurationAssignmentsWithinSubscription' + hidden: true + - select: 'parameter' + where: + parameter: duration + alias: + - maintenance-window-duration + - duration + - where: + parameter: 'expirationDateTime' + alias: + - maintenance-window-expiration-date-time + - expiration-date-time + - where: + parameter: 'recurEvery' + alias: + - maintenance-window-recur-every + - recur-every + - where: + param: startDateTime + alias: + - maintenance-window-start-date-time + - start-date-time + - where: + param: timeZone + alias: + - maintenance-window-time-zone + - time-zone + - where: + param: linuxParameters + alias: + - install-patches-linux-parameters + - linux-parameters + - where: + param: windowsParameters + alias: + - install-patches-windows-parameters + - windows-parameters + - where: + param: postTasks + alias: + - install-patches-post-tasks + - post-tasks + - where: + param: preTasks + alias: + - install-patches-pre-tasks + - pre-tasks ``` diff --git a/specification/maintenance/resource-manager/readme.md b/specification/maintenance/resource-manager/readme.md index 44bc36144a1f..55543b41196c 100644 --- a/specification/maintenance/resource-manager/readme.md +++ b/specification/maintenance/resource-manager/readme.md @@ -26,9 +26,17 @@ These are the global settings for the Azure Maintenance API. ``` yaml openapi-type: arm -tag: package-preview-2022-11 +tag: package-2023-04 ``` +### Tag: package-2023-04 + +These settings apply only when `--tag=package-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-2023-04' +input-file: + - Microsoft.Maintenance/stable/2023-04-01/Maintenance.json +``` ### Tag: package-preview-2022-11 @@ -38,6 +46,7 @@ These settings apply only when `--tag=package-preview-2022-11` is specified on t input-file: - Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json ``` + ### Tag: package-preview-2022-07 These settings apply only when `--tag=package-preview-2022-07` is specified on the command line. @@ -146,3 +155,40 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) + +### Suppression + +``` yaml +directive: + - suppress: PathForPutOperation + from: maintenance.json + reason: False postive. ConfigurationAssignments is proxy resource. + - suppress: DeleteResponseBodyEmpty + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: PathContainsResourceType + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: PathContainsResourceType + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: TrackedResourcePatchOperation + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: SubscriptionsAndResourceGroupCasing + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: UnSupportedPatchProperties + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: PathResourceProviderNamePascalCase + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: RequestSchemaForTrackedResourcesMustHaveTags + from: maintenance.json + reason: False positive. ConfigurationAssignments is proxy resource at subscription/resourceGroup level. + - suppress: ResourceNameRestriction + from: maintenance.json + reason: Maintenance RP accept any string, no special restriction required. +``` + diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/AssessedMachines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/AssessedMachines_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/AssessedMachines_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/AssessedMachines_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/AssessedMachines_ListByAssessment.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/AssessedMachines_ListByAssessment.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/AssessedMachines_ListByAssessment.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/AssessedMachines_ListByAssessment.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_GetReportDownloadUrl.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_GetReportDownloadUrl.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_GetReportDownloadUrl.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_GetReportDownloadUrl.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_ListByGroup.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_ListByGroup.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_ListByGroup.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_ListByGroup.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Assessments_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Assessments_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Groups_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Groups_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Machines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Machines_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Machines_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Machines_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Machines_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Machines_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Machines_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Machines_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Operations_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Operations_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Operations_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Operations_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_GetKeys.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_GetKeys.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_GetKeys.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_GetKeys.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Update.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Update.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/examples/Projects_Update.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/examples/Projects_Update.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/migrate.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/migrate.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/migrate.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/AssessedMachines_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/AssessedMachines_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/AssessedMachines_ListByAssessment.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessmentOptions_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/AssessmentOptions_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/AssessmentOptions_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/AssessmentOptions_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_GetReportDownloadUrl.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByGroup.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_ListByGroup.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByGroup.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_ListByGroup.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Assessments_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Assessments_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Groups_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Groups_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/LocationCheckNameAvailability_AlreadyExists.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/LocationCheckNameAvailability_AlreadyExists.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/LocationCheckNameAvailability_AlreadyExists.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/LocationCheckNameAvailability_Available.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/LocationCheckNameAvailability_Available.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/LocationCheckNameAvailability_Available.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/LocationCheckNameAvailability_Available.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Machines_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Machines_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Machines_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Machines_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Machines_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Operations_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Operations_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Operations_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Operations_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/ProjectsInSubscription_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/ProjectsInSubscription_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/ProjectsInSubscription_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/ProjectsInSubscription_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_GetKeys.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_GetKeys.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_GetKeys.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_GetKeys.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Update.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Update.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/examples/Projects_Update.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/examples/Projects_Update.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/migrate.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/migrate.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessedMachines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessedMachines_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessedMachines_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessedMachines_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessedMachines_ListByAssessment.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessedMachines_ListByAssessment.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessedMachines_ListByAssessment.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessedMachines_ListByAssessment.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessmentOptions_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessmentOptions_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessmentOptions_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessmentOptions_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessmentOptions_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessmentOptions_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/AssessmentOptions_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/AssessmentOptions_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_GetReportDownloadUrl.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_GetReportDownloadUrl.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_GetReportDownloadUrl.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_GetReportDownloadUrl.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_ListByGroup.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_ListByGroup.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_ListByGroup.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_ListByGroup.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Assessments_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Assessments_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_UpdateMachines.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_UpdateMachines.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Groups_UpdateMachines.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Groups_UpdateMachines.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/HyperVCollectors_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/HyperVCollectors_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ImportCollectors_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ImportCollectors_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Machines_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Machines_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Machines_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Machines_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Machines_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Machines_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Machines_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Machines_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Operations_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Operations_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Operations_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Operations_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateEndpointConnections_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateEndpointConnections_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateLinkResources_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateLinkResources_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateLinkResources_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateLinkResources_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateLinkResources_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateLinkResources_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/PrivateLinkResources_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/PrivateLinkResources_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ProjectsInSubscription_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ProjectsInSubscription_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ProjectsInSubscription_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ProjectsInSubscription_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Update.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Update.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/Projects_Update.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/Projects_Update.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/ServerCollectors_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/ServerCollectors_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/examples/VMwareCollectors_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/examples/VMwareCollectors_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/migrate.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2019-10-01/migrate.json rename to specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/migrate.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/Operations_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/Operations_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/Operations_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/Operations_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnection_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnection_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnection_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnection_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnections_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnections_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnections_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnections_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnections_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnections_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnections_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnections_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnections_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnections_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateEndpointConnections_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateEndpointConnections_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateLinkResources_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateLinkResources_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateLinkResources_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateLinkResources_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateLinkResources_ListByProject.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateLinkResources_ListByProject.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/PrivateLinkResources_ListByProject.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/PrivateLinkResources_ListByProject.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Create.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Create.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Create.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Create.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Delete.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Delete.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Delete.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Delete.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Get.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Get.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Get.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Get.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Patch.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Patch.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProject_Patch.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProject_Patch.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProjectsInSubscription_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProjectsInSubscription_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProjectsInSubscription_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProjectsInSubscription_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProjects_List.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProjects_List.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/examples/migrateProjects_List.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/examples/migrateProjects_List.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/hubmigrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/hubmigrate.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/stable/2020-05-01/hubmigrate.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/stable/2020-05-01/hubmigrate.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/DeployedResource_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/DeployedResource_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgentOperationStatus_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Create_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Create_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Create_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Create_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Create_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Create_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Create_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Delete_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/MigrateAgent_Refresh_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectOperationStatus_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProjectStatistics_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Create_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Create_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Create_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Create_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Create_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Create_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Create_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Delete_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_ListBySubscription_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Update_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Update_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Update_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Update_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Update_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/ModernizeProject_Update_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/ModernizeProject_Update_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Operations_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Operations_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Operations_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Operations_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Operations_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Operations_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/Workflow_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/Workflow_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeploymentOperationStatus_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_BuildContainerImage_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Create_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Delete_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_GetSecretConfigurations_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_Migrate_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrateCleanup_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadDeployment_TestMigrate_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstanceOperationStatus_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Create_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Delete_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_Get_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_List_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_List_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_List_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_List_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_List_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_List_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_MigrateComplete_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MaximumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MaximumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MaximumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MinimumSet_Gen.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MinimumSet_Gen.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/examples/WorkloadInstance_StopReplicate_MinimumSet_Gen.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/migrateEngine.json b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/migrateEngine.json similarity index 100% rename from specification/migrate/resource-manager/Microsoft.Migrate/preview/2022-05-01-preview/migrateEngine.json rename to specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/migrateEngine.json diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index b4d05c7be947..0e8cb1678d59 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -11,8 +11,9 @@ This is the AutoRest configuration file for Azure Migrate. ``` yaml $(java) && $(multiapi) batch: - tag: package-migrate-2018-02 + - tag: package-migrate-2019-10 + - tag: package-migrate-2017-11 - tag: package-migrate-2020-01 - - tag: package-migrate-2020-05 - tag: package-migrate-2020-07 - tag: package-hubmigrate-2020-05 - tag: package-migrateengine-2022-05 @@ -20,7 +21,7 @@ batch: ### Tag: package-migrate-2018-02 and java -These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +These settings apply only when `--tag=package-migrate-2018-02 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. ``` yaml $(tag) == 'package-migrate-2018-02' && $(java) && $(multiapi) @@ -31,28 +32,41 @@ regenerate-manager: true generate-interface: true ``` -### Tag: package-migrate-2020-01 and java +### Tag: package-migrate-2019-10 and java -These settings apply only when `--tag=package-migrate-2020-01 --java` is specified on the command line. +These settings apply only when `--tag=package-migrate-2019-10 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-migrate-2020-01' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-migrate-2019-10' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.azuremigrate.v2020_01_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/azuremigrate/mgmt-v2020_01_01 + namespace: com.microsoft.azure.management.azuremigrate.v2019_10_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/azuremigrate/mgmt-v2019_10_01 regenerate-manager: true generate-interface: true ``` -### Tag: package-migrate-2020-05 and java +### Tag: package-migrate-2017-11 and java -These settings apply only when `--tag=package-migrate-2020-05 --java` is specified on the command line. +These settings apply only when `--tag=package-migrate-2017-11 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-migrate-2020-05' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-migrate-2017-11' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.azuremigrate.v2020_05_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/azuremigrate/mgmt-v2020_05_01 + namespace: com.microsoft.azure.management.azuremigrate.v2017_11_11 + output-folder: $(azure-libraries-for-java-folder)/sdk/azuremigrate/mgmt-v2017_11_11 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-migrate-2020-01 and java + +These settings apply only when `--tag=package-migrate-2020-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-migrate-2020-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.azuremigrate.v2020_01_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/azuremigrate/mgmt-v2020_01_01 regenerate-manager: true generate-interface: true ``` @@ -125,7 +139,7 @@ These settings apply only when `--tag=package-migrate-2018-02` is specified on t ``` yaml $(tag) == 'package-migrate-2018-02' input-file: -- Microsoft.Migrate/stable/2018-02-02/migrate.json +- Microsoft.Migrate/AssessmentProjects/stable/2018-02-02/migrate.json ``` ### Tag: package-migrate-2019-10 @@ -134,25 +148,25 @@ These settings apply only when `--tag=package-migrate-2019-10` is specified on t ``` yaml $(tag) == 'package-migrate-2019-10' input-file: -- Microsoft.Migrate/stable/2019-10-01/migrate.json +- Microsoft.Migrate/AssessmentProjects/stable/2019-10-01/migrate.json ``` -### Tag: package-migrate-2020-01 +### Tag: package-migrate-2017-11 -These settings apply only when `--tag=package-migrate-2020-01` is specified on the command line. +These settings apply only when `--tag=package-migrate-2017-11` is specified on the command line. -``` yaml $(tag) == 'package-migrate-2020-01' +``` yaml $(tag) == 'package-migrate-2017-11' input-file: -- Microsoft.OffAzure/stable/2020-01-01/migrate.json +- Microsoft.Migrate/AssessmentProjects/preview/2017-11-11-preview/migrate.json ``` -### Tag: package-hubmigrate-2020-05 +### Tag: package-migrate-2020-01 -These settings apply only when `--tag=package-hubmigrate-2020-05` is specified on the command line. +These settings apply only when `--tag=package-migrate-2020-01` is specified on the command line. -``` yaml $(tag) == 'package-hubmigrate-2020-05' +``` yaml $(tag) == 'package-migrate-2020-01' input-file: -- Microsoft.Migrate/stable/2020-05-01/hubmigrate.json +- Microsoft.OffAzure/stable/2020-01-01/migrate.json ``` ### Tag: package-migrate-2020-07 @@ -164,13 +178,22 @@ input-file: - Microsoft.OffAzure/stable/2020-07-07/migrate.json ``` +### Tag: package-hubmigrate-2020-05 + +These settings apply only when `--tag=package-hubmigrate-2020-05` is specified on the command line. + +``` yaml $(tag) == 'package-hubmigrate-2020-05' +input-file: +- Microsoft.Migrate/MigrateProjects/stable/2020-05-01/hubmigrate.json +``` + ### Tag: package-migrateengine-2022-05 These settings apply only when `--tag=package-migrateengine-2022-05` is specified on the command line. ``` yaml $(tag) == 'package-migrateengine-2022-05' input-file: -- Microsoft.Migrate/preview/2022-05-01-preview/migrateEngine.json +- Microsoft.Migrate/MordernizeProjects/preview/2022-05-01-preview/migrateEngine.json ``` ## Suppression diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/NetworkVirtualAppliancePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/NetworkVirtualAppliancePut.json index b9e5937b43c8..40d3723cf373 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/NetworkVirtualAppliancePut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2023-02-01/examples/NetworkVirtualAppliancePut.json @@ -110,9 +110,7 @@ }, "201": { "headers": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-02-01" - } + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-02-01" }, "body": { "name": "nva", diff --git a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json index 8ade08763dbf..4a2433e12609 100644 --- a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Accounts_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json index 43f0f8695216..f7e237017bd9 100644 --- a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Accounts_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json index 8935c22fad60..e49241329e0a 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "resource": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json index 14b578a48ec1..844180915106 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Delete_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json index 2bd7a9e86be7..ed150f60437e 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Delete_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json index 457c15583e86..1ac93fd575bf 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_GetMetricRules_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json index 2d73e241ed52..731cde656d52 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_GetMetricRules_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { @@ -12,7 +12,11 @@ }, "responses": { "200": { - "body": {} + "body": { + "sendMetrics": "Disabled", + "filteringTags": [], + "userEmail": null + } } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json index 18b985411b87..3b4fcdb45653 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "azureResourceIds": [ - "enfghpfw" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ], "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } @@ -17,7 +17,7 @@ "200": { "body": { "azureResourceIds": [ - "enfghpfw" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ] } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json index 75f5018cbb36..8505847b12ba 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -3,16 +3,21 @@ "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "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": {} + "body": { + "azureResourceIds": [] + } } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json index 94906d38753c..197e8d04d4a1 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Get_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json index 073224a6b514..67a6ea17b9ec 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_ListAppServices_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "azureResourceIds": [ - "pvzrksrmzowobuhxpwiotnpcvjbu" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ], "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } @@ -18,7 +18,7 @@ "body": { "value": [ { - "azureResourceId": "kjvbkwuqmouugrrz", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "agentVersion": "owxkssnbp", "agentStatus": "vclwfecbppsfaygdccfu" } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json index fbb993f1a5d1..606d1792ce04 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -3,19 +3,21 @@ "title": "Monitors_ListAppServices_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "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": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json index ccffc4f0a4f0..4c6a891b3a76 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic" }, "responses": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json index 5b8faa549b4a..c03b1c416021 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListBySubscription_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json index ec6fefd0e4f0..820cb2ae9bb5 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListHosts_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "request": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json index 889c3df7559c..e170c607db4b 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListHosts_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "request": { @@ -16,9 +16,8 @@ "responses": { "200": { "body": { - "value": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json index 45a35f187447..636e66cfc49b 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json index d0efed12483e..f145a401f995 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -3,16 +3,15 @@ "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, "responses": { "200": { "body": { - "value": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json index 9d73a790743e..96b311607fe5 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_SwitchBilling_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "azureResourceId": "enfghpfw", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "organizationId": "k", "planData": { "usageType": "PAYG", diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json index faea5e3503f8..06bddcb3149d 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_SwitchBilling_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json index 58e7492e0746..6e22dc73bca6 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Update_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "properties": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json index 09acb2b09e82..7c53ae5e36d7 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_VmHostPayload_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json index 8bfc4d47aaa5..5df94de4f3cd 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_VmHostPayload_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json index 237bd0a9b373..7d51c73537a1 100644 --- a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Organizations_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json index 86f1e3a6e07d..c5f56aebbda9 100644 --- a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json @@ -3,18 +3,14 @@ "title": "Organizations_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, "responses": { "200": { "body": { - "value": [ - { - "id": "ycdsgeiitvxcd" - } - ] + "value": [] } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json index a0c7f196b6a9..d98c6f874c9a 100644 --- a/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Plans_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "accountId": "pwuxgvrmkk", "organizationId": "hilawwjz" }, diff --git a/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json index 9854b0772731..7881d45caeb8 100644 --- a/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json @@ -3,14 +3,18 @@ "title": "Plans_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf" + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "organizationId": "hilawwjz" }, "responses": { "200": { "body": { "value": [ { - "id": "ycdsgeiitvxcd" + "id": "qmtrcoxuctyphc", + "properties": { + "orgCreationSource": "NEWRELIC" + } } ] } diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json index 54b8fa7475e4..5aca2dfc466d 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json index 13f97856c33f..a3b33401e6d6 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json index e2e293eeda76..d2c5b3338bea 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Delete_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json index 973b43148a9f..ece4c4d2d6f7 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Delete_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json index 899ab8ca56cb..4c3da6213c04 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Get_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json index 32afa96ac241..7e94172a562e 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Get_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json index acbf4317fbf7..e32af021e1b3 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json index db4b787c7dbd..f4b3973f91c9 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json index 2b800d0d4001..e309fccc33fb 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Update_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json index 2509e70c6744..4ce64658f2b0 100644 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Update_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MaximumSet_Gen.json index 8ade08763dbf..4a2433e12609 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Accounts_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MinimumSet_Gen.json index 43f0f8695216..f7e237017bd9 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Accounts_List_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Accounts_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json index 8935c22fad60..e49241329e0a 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "resource": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json index 15944e1187ce..cfda7e34e777 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Delete_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json index 36fb8f2f94c8..3ac7b9901730 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Delete_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json index 457c15583e86..1ac93fd575bf 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_GetMetricRules_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json index 2d73e241ed52..731cde656d52 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_GetMetricRules_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { @@ -12,7 +12,11 @@ }, "responses": { "200": { - "body": {} + "body": { + "sendMetrics": "Disabled", + "filteringTags": [], + "userEmail": null + } } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json index 18b985411b87..3b4fcdb45653 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "azureResourceIds": [ - "enfghpfw" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ], "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } @@ -17,7 +17,7 @@ "200": { "body": { "azureResourceIds": [ - "enfghpfw" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ] } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json index 75f5018cbb36..8505847b12ba 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -3,16 +3,21 @@ "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "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": {} + "body": { + "azureResourceIds": [] + } } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Get_MaximumSet_Gen.json index 94906d38753c..197e8d04d4a1 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Get_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Get_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Get_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json index f29dde7a6e08..f253c26cc3be 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_ListAppServices_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "azureResourceIds": [ - "pvzrksrmzowobuhxpwiotnpcvjbu" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ], "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } @@ -18,7 +18,7 @@ "body": { "value": [ { - "azureResourceId": "kjvbkwuqmouugrrz", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "agentVersion": "owxkssnbp", "agentStatus": "vclwfecbppsfaygdccfu" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json index fbb993f1a5d1..606d1792ce04 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -3,19 +3,21 @@ "title": "Monitors_ListAppServices_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "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": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json index ccffc4f0a4f0..4c6a891b3a76 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic" }, "responses": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json index 5b8faa549b4a..c03b1c416021 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListBySubscription_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json index ec6fefd0e4f0..820cb2ae9bb5 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListHosts_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "request": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json index 889c3df7559c..e170c607db4b 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListHosts_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "request": { @@ -16,9 +16,8 @@ "responses": { "200": { "body": { - "value": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json index 45a35f187447..636e66cfc49b 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json index d0efed12483e..f145a401f995 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -3,16 +3,15 @@ "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, "responses": { "200": { "body": { - "value": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json index 9d73a790743e..96b311607fe5 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_SwitchBilling_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "azureResourceId": "enfghpfw", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "organizationId": "k", "planData": { "usageType": "PAYG", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json index faea5e3503f8..06bddcb3149d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_SwitchBilling_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Update_MaximumSet_Gen.json index 58e7492e0746..6e22dc73bca6 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Update_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Update_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "properties": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json index 09acb2b09e82..7c53ae5e36d7 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_VmHostPayload_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json index 8bfc4d47aaa5..5df94de4f3cd 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_VmHostPayload_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MaximumSet_Gen.json index 237bd0a9b373..7d51c73537a1 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Organizations_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MinimumSet_Gen.json index 86f1e3a6e07d..c5f56aebbda9 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Organizations_List_MinimumSet_Gen.json @@ -3,18 +3,14 @@ "title": "Organizations_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, "responses": { "200": { "body": { - "value": [ - { - "id": "ycdsgeiitvxcd" - } - ] + "value": [] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MaximumSet_Gen.json index a0c7f196b6a9..d98c6f874c9a 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Plans_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "accountId": "pwuxgvrmkk", "organizationId": "hilawwjz" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MinimumSet_Gen.json index 9854b0772731..7881d45caeb8 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/Plans_List_MinimumSet_Gen.json @@ -3,14 +3,18 @@ "title": "Plans_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "nqmcgifgaqlf" + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "organizationId": "hilawwjz" }, "responses": { "200": { "body": { "value": [ { - "id": "ycdsgeiitvxcd" + "id": "qmtrcoxuctyphc", + "properties": { + "orgCreationSource": "NEWRELIC" + } } ] } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json index 54b8fa7475e4..5aca2dfc466d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json index 13f97856c33f..a3b33401e6d6 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json index e2e293eeda76..d2c5b3338bea 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Delete_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json index 973b43148a9f..ece4c4d2d6f7 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Delete_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MaximumSet_Gen.json index 899ab8ca56cb..4c3da6213c04 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Get_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MinimumSet_Gen.json index 32afa96ac241..7e94172a562e 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Get_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Get_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json index acbf4317fbf7..e32af021e1b3 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json index db4b787c7dbd..f4b3973f91c9 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MaximumSet_Gen.json index 2b800d0d4001..e309fccc33fb 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Update_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MinimumSet_Gen.json index 2509e70c6744..4ce64658f2b0 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/examples/TagRules_Update_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Update_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01-preview", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MaximumSet_Gen.json index 5456b731a6a7..930d5545af45 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Accounts_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MinimumSet_Gen.json index 14019914a163..a0ee996a78d6 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Accounts_List_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Accounts_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json index 9a497037a7d9..0ce986574081 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "resource": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MaximumSet_Gen.json index 83f021a06ba7..a250cb881ee5 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Delete_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MinimumSet_Gen.json index cdd22bad4ad9..369c73e4ab22 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Delete_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Delete_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json index 6e0686f3c7c9..c7e8b2d2c5f7 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_GetMetricRules_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json index fbf39255faed..1dbb13343f8c 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_GetMetricRules_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { @@ -12,7 +12,11 @@ }, "responses": { "200": { - "body": {} + "body": { + "sendMetrics": "Disabled", + "filteringTags": [], + "userEmail": null + } } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json index 6406a9f9d1fe..0da7d58f8a79 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "azureResourceIds": [ - "enfghpfw" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ], "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } @@ -17,7 +17,7 @@ "200": { "body": { "azureResourceIds": [ - "enfghpfw" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ] } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json index a836b416ef62..316f94708c41 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -3,16 +3,21 @@ "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "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": {} + "body": { + "azureResourceIds": [] + } } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Get_MaximumSet_Gen.json index 21201967003a..e741c7768a29 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Get_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Get_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Get_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json index 0feb2c9638ba..9e6d89285d2d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_ListAppServices_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "azureResourceIds": [ - "pvzrksrmzowobuhxpwiotnpcvjbu" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" ], "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } @@ -18,7 +18,7 @@ "body": { "value": [ { - "azureResourceId": "kjvbkwuqmouugrrz", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "agentVersion": "owxkssnbp", "agentStatus": "vclwfecbppsfaygdccfu" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json index 71391193a70d..1e0e3540101d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -3,19 +3,21 @@ "title": "Monitors_ListAppServices_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "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": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json index 84ea49176268..031e51840a52 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic" }, "responses": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json index dc52afe6a51e..0dec65430f1a 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListBySubscription_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "hfmjmpyqgezxkp" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MaximumSet_Gen.json index d28a6c9b5cd1..ab73aff90e83 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListHosts_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "request": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MinimumSet_Gen.json index ff4308ce1d79..6ec6ad37ceec 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListHosts_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "request": { @@ -16,9 +16,8 @@ "responses": { "200": { "body": { - "value": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json index 6d9c1bc6bf67..75cbfad32688 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json index 83936b0949e5..98e9317dccab 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -3,16 +3,15 @@ "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, "responses": { "200": { "body": { - "value": [ - {} - ] + "value": [], + "nextLink": null } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json index 1b85702b56de..668e9fda12c5 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -3,12 +3,12 @@ "title": "Monitors_SwitchBilling_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "azureResourceId": "enfghpfw", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "organizationId": "k", "planData": { "usageType": "PAYG", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json index e87aedc2bede..cca1f3fb9154 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_SwitchBilling_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", "request": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Update_MaximumSet_Gen.json index 09f603775cdc..dab29bf96156 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Update_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_Update_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "properties": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json index 29639e46598f..6a47ac00b6e5 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_VmHostPayload_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json index 8e8ec4ab8cef..460ddce1fc59 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Monitors_VmHostPayload_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MaximumSet_Gen.json index 82c28f30d8c0..5e581c70ce81 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Organizations_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MinimumSet_Gen.json index 6603b91cf7b8..8bd8565d15dd 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Organizations_List_MinimumSet_Gen.json @@ -3,18 +3,14 @@ "title": "Organizations_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "location": "egh" }, "responses": { "200": { "body": { - "value": [ - { - "id": "ycdsgeiitvxcd" - } - ] + "value": [] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MaximumSet_Gen.json index 5bfafc5faa63..0ab6824cb175 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "Plans_List_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "hfmjmpyqgezxkp", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "accountId": "pwuxgvrmkk", "organizationId": "hilawwjz" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MinimumSet_Gen.json index a50f42bd4cb5..5f92e66583f3 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Plans_List_MinimumSet_Gen.json @@ -3,14 +3,18 @@ "title": "Plans_List_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "nqmcgifgaqlf" + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "organizationId": "hilawwjz" }, "responses": { "200": { "body": { "value": [ { - "id": "ycdsgeiitvxcd" + "id": "qmtrcoxuctyphc", + "properties": { + "orgCreationSource": "NEWRELIC" + } } ] } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json index 51506555d40b..c11974ef81db 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json index cead6071efb2..8a206bf05f30 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MaximumSet_Gen.json index de3e48956577..5fc7156b79cb 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Delete_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MinimumSet_Gen.json index efe94413cf48..4c0c96380d43 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Delete_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Delete_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MaximumSet_Gen.json index d9ce13413146..3b7ab92f2d12 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Get_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MinimumSet_Gen.json index ecc6c114dcdf..d72730369ef8 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Get_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Get_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json index 61145e009934..4a5f589bd0f8 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json index f0c5ec5f0abc..55067e0a590d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron" }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MaximumSet_Gen.json index 3a9d1fdd5fd3..048e5a501271 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MaximumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Update_MaximumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MinimumSet_Gen.json index 80a01dda2953..decbc5a9aa32 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/TagRules_Update_MinimumSet_Gen.json @@ -3,7 +3,7 @@ "title": "TagRules_Update_MinimumSet_Gen", "parameters": { "api-version": "2022-07-01", - "subscriptionId": "ddqonpqwjr", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/bms.json index d5561fec56dd..0f937f43d9ff 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-02-01/bms.json @@ -9666,7 +9666,7 @@ } }, "isSoftDeleteFeatureStateEditable": { - "description": "Is soft delete feature state editable", + "description": "This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault", "type": "boolean" } } diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-04-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-04-01/bms.json index cd7aed8b12d4..258910690d9a 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-04-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-04-01/bms.json @@ -9674,7 +9674,7 @@ } }, "isSoftDeleteFeatureStateEditable": { - "description": "Is soft delete feature state editable", + "description": "This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault", "type": "boolean" } } diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2023-07-01-preview/changes.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2023-07-01-preview/changes.json index a2b0cf9b4943..c227106fe974 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/preview/2023-07-01-preview/changes.json +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2023-07-01-preview/changes.json @@ -303,33 +303,7 @@ "clientType": { "description": "Client used to make the changes", "type": "string", - "readOnly": true, - "enum": [ - "CLI", - "Portal", - "SDK" - ], - "x-ms-enum": { - "name": "clientType", - "modelAsString": true, - "values": [ - { - "value": "CLI", - "description": "The change(s) were made through the Command Line Interface", - "name": "CLI" - }, - { - "value": "Portal", - "description": "The change(s) were made through the Portal", - "name": "Portal" - }, - { - "value": "SDK", - "description": "The change(s) were made through a Software Development Kit", - "name": "SDK" - } - ] - } + "readOnly": true }, "operation": { "description": "The Azure Resource Provider operation that was invoked to make the change(s). See [here](https://learn.microsoft.com/en-us/azure/role-based-access-control/resource-provider-operations) for a full list of possible values", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json index 54ab38a98949..f094382d1f46 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json @@ -55,10 +55,10 @@ "paths": { "/providers/Microsoft.ServiceNetworking/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -79,22 +79,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get Operations List": { "$ref": "./examples/OperationsList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers": { "get": { + "operationId": "TrafficControllerInterface_ListBySubscription", "tags": [ "TrafficControllerInterface" ], - "operationId": "TrafficControllerInterface_ListBySubscription", "description": "List TrafficController resources by subscription ID", "parameters": [ { @@ -118,22 +118,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get Traffic Controllers List": { "$ref": "./examples/TrafficControllersGetList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers": { "get": { + "operationId": "TrafficControllerInterface_ListByResourceGroup", "tags": [ "TrafficControllerInterface" ], - "operationId": "TrafficControllerInterface_ListByResourceGroup", "description": "List TrafficController resources by resource group", "parameters": [ { @@ -160,22 +160,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get Traffic Controllers": { "$ref": "./examples/TrafficControllersGet.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}": { "get": { + "operationId": "TrafficControllerInterface_Get", "tags": [ "TrafficControllerInterface" ], - "operationId": "TrafficControllerInterface_Get", "description": "Get a TrafficController", "parameters": [ { @@ -190,8 +190,8 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -217,10 +217,10 @@ } }, "put": { + "operationId": "TrafficControllerInterface_CreateOrUpdate", "tags": [ "TrafficControllerInterface" ], - "operationId": "TrafficControllerInterface_CreateOrUpdate", "description": "Create a TrafficController", "parameters": [ { @@ -235,16 +235,16 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/TrafficController" } @@ -259,15 +259,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/TrafficController" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/TrafficController" } }, "default": { @@ -288,10 +288,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "TrafficControllerInterface_Update", "tags": [ "TrafficControllerInterface" ], - "operationId": "TrafficControllerInterface_Update", "description": "Update a TrafficController", "parameters": [ { @@ -306,16 +306,16 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/TrafficControllerUpdate" } @@ -342,10 +342,10 @@ } }, "delete": { + "operationId": "TrafficControllerInterface_Delete", "tags": [ "TrafficControllerInterface" ], - "operationId": "TrafficControllerInterface_Delete", "description": "Delete a TrafficController", "parameters": [ { @@ -360,8 +360,8 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -374,13 +374,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -407,10 +407,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations": { "get": { + "operationId": "AssociationsInterface_ListByTrafficController", "tags": [ "AssociationsInterface" ], - "operationId": "AssociationsInterface_ListByTrafficController", "description": "List Association resources by TrafficController", "parameters": [ { @@ -425,8 +425,8 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -445,22 +445,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get Associations": { "$ref": "./examples/AssociationsGet.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}": { "get": { + "operationId": "AssociationsInterface_Get", "tags": [ "AssociationsInterface" ], - "operationId": "AssociationsInterface_Get", "description": "Get a Association", "parameters": [ { @@ -475,16 +475,16 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "associationName", "in": "path", - "required": true, "description": "Name of Association", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -510,10 +510,10 @@ } }, "put": { + "operationId": "AssociationsInterface_CreateOrUpdate", "tags": [ "AssociationsInterface" ], - "operationId": "AssociationsInterface_CreateOrUpdate", "description": "Create a Association", "parameters": [ { @@ -528,24 +528,24 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "associationName", "in": "path", - "required": true, "description": "Name of Association", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Association" } @@ -560,15 +560,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Association" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Association" } }, "default": { @@ -589,10 +589,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "AssociationsInterface_Update", "tags": [ "AssociationsInterface" ], - "operationId": "AssociationsInterface_Update", "description": "Update a Association", "parameters": [ { @@ -607,24 +607,24 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "associationName", "in": "path", - "required": true, "description": "Name of Association", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/AssociationUpdate" } @@ -651,10 +651,10 @@ } }, "delete": { + "operationId": "AssociationsInterface_Delete", "tags": [ "AssociationsInterface" ], - "operationId": "AssociationsInterface_Delete", "description": "Delete a Association", "parameters": [ { @@ -669,16 +669,16 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "associationName", "in": "path", - "required": true, "description": "Name of Association", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -691,13 +691,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -724,10 +724,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends": { "get": { + "operationId": "FrontendsInterface_ListByTrafficController", "tags": [ "FrontendsInterface" ], - "operationId": "FrontendsInterface_ListByTrafficController", "description": "List Frontend resources by TrafficController", "parameters": [ { @@ -742,8 +742,8 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -762,22 +762,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Get Frontends": { "$ref": "./examples/FrontendsGet.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}": { "get": { + "operationId": "FrontendsInterface_Get", "tags": [ "FrontendsInterface" ], - "operationId": "FrontendsInterface_Get", "description": "Get a Frontend", "parameters": [ { @@ -792,16 +792,16 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "frontendName", "in": "path", - "required": true, "description": "Frontends", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -827,10 +827,10 @@ } }, "put": { + "operationId": "FrontendsInterface_CreateOrUpdate", "tags": [ "FrontendsInterface" ], - "operationId": "FrontendsInterface_CreateOrUpdate", "description": "Create a Frontend", "parameters": [ { @@ -845,24 +845,24 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "frontendName", "in": "path", - "required": true, "description": "Frontends", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Frontend" } @@ -877,15 +877,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Frontend" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Frontend" } }, "default": { @@ -906,10 +906,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "FrontendsInterface_Update", "tags": [ "FrontendsInterface" ], - "operationId": "FrontendsInterface_Update", "description": "Update a Frontend", "parameters": [ { @@ -924,24 +924,24 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "frontendName", "in": "path", - "required": true, "description": "Frontends", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/FrontendUpdate" } @@ -968,10 +968,10 @@ } }, "delete": { + "operationId": "FrontendsInterface_Delete", "tags": [ "FrontendsInterface" ], - "operationId": "FrontendsInterface_Delete", "description": "Delete a Frontend", "parameters": [ { @@ -986,16 +986,16 @@ { "name": "trafficControllerName", "in": "path", - "required": true, "description": "traffic controller name for path", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" }, { "name": "frontendName", "in": "path", - "required": true, "description": "Frontends", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$" } @@ -1008,13 +1008,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1043,6 +1043,7 @@ "definitions": { "Association": { "type": "object", + "description": "Association Subresource of Traffic Controller", "properties": { "properties": { "$ref": "#/definitions/AssociationProperties", @@ -1054,7 +1055,6 @@ ] } }, - "description": "Association Subresource of Traffic Controller", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -1063,29 +1063,28 @@ }, "AssociationListResult": { "type": "object", + "description": "The response of a Association list operation.", "properties": { "value": { "type": "array", + "description": "The Association items on this page", "items": { "$ref": "#/definitions/Association" - }, - "description": "The Association items on this page", - "x-typespec-name": "Association[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Association list operation.", "required": [ "value" ] }, "AssociationProperties": { "type": "object", + "description": "Association Properties.", "properties": { "associationType": { "$ref": "#/definitions/AssociationType", @@ -1101,33 +1100,32 @@ "readOnly": true } }, - "description": "Association Properties.", "required": [ "associationType" ] }, "AssociationSubnet": { "type": "object", + "description": "Association Subnet.", "properties": { "id": { "type": "string", "description": "Association ID." } }, - "description": "Association Subnet.", "required": [ "id" ] }, "AssociationSubnetUpdate": { "type": "object", + "description": "Association Subnet.", "properties": { "id": { "type": "string", "description": "Association ID." } - }, - "description": "Association Subnet." + } }, "AssociationType": { "type": "string", @@ -1141,24 +1139,24 @@ }, "AssociationUpdate": { "type": "object", + "description": "The type used for update operations of the Association.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/AssociationUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the Association." + } }, "AssociationUpdateProperties": { "type": "object", + "description": "The updatable properties of the Association.", "properties": { "associationType": { "$ref": "#/definitions/AssociationType", @@ -1168,11 +1166,11 @@ "$ref": "#/definitions/AssociationSubnetUpdate", "description": "Association Subnet" } - }, - "description": "The updatable properties of the Association." + } }, "Frontend": { "type": "object", + "description": "Frontend Subresource of Traffic Controller.", "properties": { "properties": { "$ref": "#/definitions/FrontendProperties", @@ -1184,7 +1182,6 @@ ] } }, - "description": "Frontend Subresource of Traffic Controller.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -1193,29 +1190,28 @@ }, "FrontendListResult": { "type": "object", + "description": "The response of a Frontend list operation.", "properties": { "value": { "type": "array", + "description": "The Frontend items on this page", "items": { "$ref": "#/definitions/Frontend" - }, - "description": "The Frontend items on this page", - "x-typespec-name": "Frontend[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Frontend list operation.", "required": [ "value" ] }, "FrontendProperties": { "type": "object", + "description": "Frontend Properties.", "properties": { "fqdn": { "type": "string", @@ -1227,22 +1223,20 @@ "description": "Provisioning State of Traffic Controller Frontend Resource", "readOnly": true } - }, - "description": "Frontend Properties." + } }, "FrontendUpdate": { "type": "object", + "description": "The type used for update operations of the Frontend.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } } - }, - "description": "The type used for update operations of the Frontend." + } }, "ProvisioningState": { "type": "string", @@ -1262,19 +1256,20 @@ }, "ResourceId": { "type": "object", + "description": "Resource ID definition used by parent to reference child resources.", "properties": { "id": { "type": "string", "description": "Resource ID of child resource." } }, - "description": "Resource ID definition used by parent to reference child resources.", "required": [ "id" ] }, "TrafficController": { "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/TrafficControllerProperties", @@ -1286,7 +1281,6 @@ ] } }, - "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -1295,55 +1289,51 @@ }, "TrafficControllerListResult": { "type": "object", + "description": "The response of a TrafficController list operation.", "properties": { "value": { "type": "array", + "description": "The TrafficController items on this page", "items": { "$ref": "#/definitions/TrafficController" - }, - "description": "The TrafficController items on this page", - "x-typespec-name": "TrafficController[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a TrafficController list operation.", "required": [ "value" ] }, "TrafficControllerProperties": { "type": "object", + "description": "Traffic Controller Properties.", "properties": { "configurationEndpoints": { "type": "array", + "description": "Configuration Endpoints.", "items": { "type": "string" }, - "description": "Configuration Endpoints.", - "x-typespec-name": "string[]", "readOnly": true }, "frontends": { "type": "array", + "description": "Frontends References List", "items": { "$ref": "#/definitions/ResourceId" }, - "description": "Frontends References List", - "x-typespec-name": "ResourceId[]", "readOnly": true }, "associations": { "type": "array", + "description": "Associations References List", "items": { "$ref": "#/definitions/ResourceId" }, - "description": "Associations References List", - "x-typespec-name": "ResourceId[]", "readOnly": true }, "provisioningState": { @@ -1351,22 +1341,20 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "Traffic Controller Properties." + } }, "TrafficControllerUpdate": { "type": "object", + "description": "The type used for update operations of the TrafficController.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } } - }, - "description": "The type used for update operations of the TrafficController." + } } }, "parameters": {} diff --git a/specification/sphere/Sphere.Management/catalog.tsp b/specification/sphere/Sphere.Management/catalog.tsp index f5c8b98964f4..4c3c92621d38 100644 --- a/specification/sphere/Sphere.Management/catalog.tsp +++ b/specification/sphere/Sphere.Management/catalog.tsp @@ -73,7 +73,7 @@ interface Catalogs @armResourceAction(Catalog) @post countDevices( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; @autoRoute @@ -82,7 +82,7 @@ interface Catalogs @post listDeviceInsights( ...ResourceInstanceParameters, - ...ListQueryParameters + ...ListQueryParameters, ): ArmResponse> | ErrorResponse; @autoRoute @@ -91,7 +91,7 @@ interface Catalogs @post listDevices( ...ResourceInstanceParameters, - ...ListQueryParameters + ...ListQueryParameters, ): ArmResponse> | ErrorResponse; @autoRoute @@ -100,7 +100,7 @@ interface Catalogs @post listDeployments( ...ResourceInstanceParameters, - ...ListQueryParameters + ...ListQueryParameters, ): ArmResponse> | ErrorResponse; @autoRoute @@ -113,6 +113,6 @@ interface Catalogs @doc("List device groups for catalog.") @body - listDeviceGroupsRequest: ListDeviceGroupsRequest + listDeviceGroupsRequest: ListDeviceGroupsRequest, ): ArmResponse> | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/certificate.tsp b/specification/sphere/Sphere.Management/certificate.tsp index 4f5caca0c218..0f8427e3b695 100644 --- a/specification/sphere/Sphere.Management/certificate.tsp +++ b/specification/sphere/Sphere.Management/certificate.tsp @@ -31,7 +31,7 @@ interface Certificates @armResourceAction(Certificate) @post retrieveCertChain( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; @autoRoute @@ -43,7 +43,7 @@ interface Certificates @doc("Proof of possession nonce request body ") @body - proofOfPossessionNonceRequest: ProofOfPossessionNonceRequest + proofOfPossessionNonceRequest: ProofOfPossessionNonceRequest, ): ArmResponse | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/common.tsp b/specification/sphere/Sphere.Management/common.tsp index a33b44e20344..239b23b73fe6 100644 --- a/specification/sphere/Sphere.Management/common.tsp +++ b/specification/sphere/Sphere.Management/common.tsp @@ -154,7 +154,7 @@ interface CustomUpdateOperations { @doc("The resource properties to be updated.") @body - properties: TPatchModel + properties: TPatchModel, ): ArmResponse | ArmAcceptedResponse<"Resource update request accepted."> | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/device.tsp b/specification/sphere/Sphere.Management/device.tsp index 3d45223d98b7..c28e96135bfa 100644 --- a/specification/sphere/Sphere.Management/device.tsp +++ b/specification/sphere/Sphere.Management/device.tsp @@ -62,7 +62,7 @@ interface Devices extends ProxyResourceOperationsDevice { @doc("Generate capability image request body.") @body - generateDeviceCapabilityRequest: GenerateCapabilityImageRequest + generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, ): ArmResponse | ArmAcceptedResponse | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/deviceGroup.tsp b/specification/sphere/Sphere.Management/deviceGroup.tsp index b52e98e2f557..acb3c5bbe5e2 100644 --- a/specification/sphere/Sphere.Management/deviceGroup.tsp +++ b/specification/sphere/Sphere.Management/deviceGroup.tsp @@ -55,7 +55,7 @@ interface DeviceGroups @armResourceAction(DeviceGroup) @post countDevices( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; @autoRoute @@ -74,7 +74,7 @@ interface DeviceGroups @doc("Bulk claim devices request body.") @body - claimDevicesRequest: ClaimDevicesRequest + claimDevicesRequest: ClaimDevicesRequest, ): ArmAcceptedResponse | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/product.tsp b/specification/sphere/Sphere.Management/product.tsp index 430b71f47178..09d6c83c9dad 100644 --- a/specification/sphere/Sphere.Management/product.tsp +++ b/specification/sphere/Sphere.Management/product.tsp @@ -49,7 +49,7 @@ interface Products extends ProxyResourceOperationsProducts { @armResourceAction(Product) @post generateDefaultDeviceGroups( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse> | ErrorResponse; @autoRoute @@ -57,7 +57,7 @@ interface Products extends ProxyResourceOperationsProducts { @armResourceAction(Product) @post countDevices( - ...ResourceInstanceParameters + ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; } 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 aa20184550d6..9a3713ef8493 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 @@ -67,10 +67,10 @@ "paths": { "/providers/Microsoft.AzureSphere/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -91,22 +91,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Catalogs_ListBySubscription", "description": "List Catalog resources by subscription ID", "parameters": [ { @@ -130,22 +130,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Catalogs_ListByResourceGroup", "description": "List Catalog resources by resource group", "parameters": [ { @@ -172,22 +172,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Catalogs_Get", "description": "Get a Catalog", "parameters": [ { @@ -202,8 +202,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" } @@ -229,10 +229,10 @@ } }, "put": { + "operationId": "Catalogs_CreateOrUpdate", "tags": [ "Catalogs" ], - "operationId": "Catalogs_CreateOrUpdate", "description": "Create a Catalog", "parameters": [ { @@ -247,16 +247,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Catalog" } @@ -271,15 +271,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Catalog" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Catalog" } }, "default": { @@ -300,10 +300,10 @@ "x-ms-long-running-operation": true }, "patch": { + "operationId": "Catalogs_Update", "tags": [ "Catalogs" ], - "operationId": "Catalogs_Update", "description": "Update a Catalog", "parameters": [ { @@ -318,16 +318,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/CatalogUpdate" } @@ -354,10 +354,10 @@ } }, "delete": { + "operationId": "Catalogs_Delete", "tags": [ "Catalogs" ], - "operationId": "Catalogs_Delete", "description": "Delete a Catalog", "parameters": [ { @@ -372,8 +372,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" } @@ -386,13 +386,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -419,10 +419,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates": { "get": { + "operationId": "Certificates_ListByCatalog", "tags": [ "Certificates" ], - "operationId": "Certificates_ListByCatalog", "description": "List Certificate resources by Catalog", "parameters": [ { @@ -449,8 +449,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" } @@ -469,22 +469,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Certificates_Get", "description": "Get a Certificate", "parameters": [ { @@ -499,16 +499,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "serialNumber", "in": "path", - "required": true, "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, "type": "string" } ], @@ -535,10 +535,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain": { "post": { + "operationId": "Certificates_RetrieveCertChain", "tags": [ "Certificates" ], - "operationId": "Certificates_RetrieveCertChain", "description": "Retrieves cert chain.", "parameters": [ { @@ -553,16 +553,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "serialNumber", "in": "path", - "required": true, "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, "type": "string" } ], @@ -589,10 +589,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce": { "post": { + "operationId": "Certificates_RetrieveProofOfPossessionNonce", "tags": [ "Certificates" ], - "operationId": "Certificates_RetrieveProofOfPossessionNonce", "description": "Gets the proof of possession nonce.", "parameters": [ { @@ -607,23 +607,23 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "serialNumber", "in": "path", - "required": true, "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, "type": "string" }, { "name": "proofOfPossessionNonceRequest", "in": "body", - "required": true, "description": "Proof of possession nonce request body ", + "required": true, "schema": { "$ref": "#/definitions/ProofOfPossessionNonceRequest" } @@ -652,10 +652,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices": { "post": { + "operationId": "Catalogs_CountDevices", "tags": [ "Catalogs" ], - "operationId": "Catalogs_CountDevices", "description": "Counts devices in catalog.", "parameters": [ { @@ -670,8 +670,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" } @@ -699,10 +699,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images": { "get": { + "operationId": "Images_ListByCatalog", "tags": [ "Images" ], - "operationId": "Images_ListByCatalog", "description": "List Image resources by Catalog", "parameters": [ { @@ -729,8 +729,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" } @@ -749,22 +749,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Images_Get", "description": "Get a Image", "parameters": [ { @@ -779,16 +779,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "imageName", "in": "path", - "required": true, "description": "Image name. Use .default for image creation.", + "required": true, "type": "string" } ], @@ -813,10 +813,10 @@ } }, "put": { + "operationId": "Images_CreateOrUpdate", "tags": [ "Images" ], - "operationId": "Images_CreateOrUpdate", "description": "Create a Image", "parameters": [ { @@ -831,23 +831,23 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "imageName", "in": "path", - "required": true, "description": "Image name. Use .default for image creation.", + "required": true, "type": "string" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Image" } @@ -862,15 +862,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Image" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Image" } }, "default": { @@ -891,10 +891,10 @@ "x-ms-long-running-operation": true }, "delete": { + "operationId": "Images_Delete", "tags": [ "Images" ], - "operationId": "Images_Delete", "description": "Delete a Image", "parameters": [ { @@ -909,16 +909,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "imageName", "in": "path", - "required": true, "description": "Image name. Use .default for image creation.", + "required": true, "type": "string" } ], @@ -930,13 +930,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -963,10 +963,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments": { "post": { + "operationId": "Catalogs_ListDeployments", "tags": [ "Catalogs" ], - "operationId": "Catalogs_ListDeployments", "description": "Lists deployments for catalog.", "parameters": [ { @@ -981,8 +981,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, @@ -1013,22 +1013,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Catalogs_ListDeviceGroups", "description": "List the device groups for the catalog.", "parameters": [ { @@ -1043,8 +1043,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, @@ -1063,8 +1063,8 @@ { "name": "listDeviceGroupsRequest", "in": "body", - "required": true, "description": "List device groups for catalog.", + "required": true, "schema": { "$ref": "#/definitions/ListDeviceGroupsRequest" } @@ -1084,22 +1084,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Catalogs_ListDeviceInsights", "description": "Lists device insights for catalog.", "parameters": [ { @@ -1114,8 +1114,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, @@ -1146,22 +1146,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Catalogs_ListDevices", "description": "Lists devices for catalog.", "parameters": [ { @@ -1176,8 +1176,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, @@ -1208,22 +1208,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Products_ListByCatalog", "description": "List Product resources by Catalog", "parameters": [ { @@ -1238,8 +1238,8 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" } @@ -1258,22 +1258,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Products_Get", "description": "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", "parameters": [ { @@ -1288,16 +1288,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" } @@ -1323,10 +1323,10 @@ } }, "put": { + "operationId": "Products_CreateOrUpdate", "tags": [ "Products" ], - "operationId": "Products_CreateOrUpdate", "description": "Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", "parameters": [ { @@ -1341,24 +1341,24 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Product" } @@ -1373,15 +1373,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Product" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Product" } }, "default": { @@ -1401,12 +1401,12 @@ }, "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "Products_Update", "tags": [ "Products" ], - "operationId": "Products_Delete", - "description": "Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'", + "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" @@ -1420,41 +1420,50 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "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": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Product" + } }, "202": { - "description": "Resource deletion accepted.", + "description": "Resource update request 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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -1463,8 +1472,8 @@ } }, "x-ms-examples": { - "Products_Delete": { - "$ref": "./examples/DeleteProduct.json" + "Products_Update": { + "$ref": "./examples/PatchProduct.json" } }, "x-ms-long-running-operation-options": { @@ -1472,12 +1481,12 @@ }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "Products_Delete", "tags": [ "Products" ], - "operationId": "Products_Update", - "description": "Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "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" @@ -1491,50 +1500,41 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/ProductUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Product" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -1543,8 +1543,8 @@ } }, "x-ms-examples": { - "Products_Update": { - "$ref": "./examples/PatchProduct.json" + "Products_Delete": { + "$ref": "./examples/DeleteProduct.json" } }, "x-ms-long-running-operation-options": { @@ -1555,10 +1555,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/countDevices": { "post": { + "operationId": "Products_CountDevices", "tags": [ "Products" ], - "operationId": "Products_CountDevices", "description": "Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", "parameters": [ { @@ -1573,16 +1573,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" } @@ -1610,10 +1610,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups": { "get": { + "operationId": "DeviceGroups_ListByProduct", "tags": [ "DeviceGroups" ], - "operationId": "DeviceGroups_ListByProduct", "description": "List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", "parameters": [ { @@ -1640,16 +1640,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" } @@ -1668,22 +1668,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "DeviceGroups_Get", "description": "Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -1698,24 +1698,24 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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$" } @@ -1741,10 +1741,10 @@ } }, "put": { + "operationId": "DeviceGroups_CreateOrUpdate", "tags": [ "DeviceGroups" ], - "operationId": "DeviceGroups_CreateOrUpdate", "description": "Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -1759,32 +1759,32 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/DeviceGroup" } @@ -1799,15 +1799,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroup" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/DeviceGroup" } }, "default": { @@ -1827,12 +1827,12 @@ }, "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "DeviceGroups_Update", "tags": [ "DeviceGroups" ], - "operationId": "DeviceGroups_Delete", - "description": "Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "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" @@ -1846,49 +1846,58 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } }, "202": { - "description": "Resource deletion accepted.", + "description": "Resource update request 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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -1897,8 +1906,8 @@ } }, "x-ms-examples": { - "DeviceGroups_Delete": { - "$ref": "./examples/DeleteDeviceGroup.json" + "DeviceGroups_Update": { + "$ref": "./examples/PatchDeviceGroup.json" } }, "x-ms-long-running-operation-options": { @@ -1906,12 +1915,12 @@ }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "DeviceGroups_Delete", "tags": [ "DeviceGroups" ], - "operationId": "DeviceGroups_Update", - "description": "Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "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" @@ -1925,58 +1934,49 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/DeviceGroupUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/DeviceGroup" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "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": { @@ -1985,8 +1985,8 @@ } }, "x-ms-examples": { - "DeviceGroups_Update": { - "$ref": "./examples/PatchDeviceGroup.json" + "DeviceGroups_Delete": { + "$ref": "./examples/DeleteDeviceGroup.json" } }, "x-ms-long-running-operation-options": { @@ -1997,10 +1997,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices": { "post": { + "operationId": "DeviceGroups_ClaimDevices", "tags": [ "DeviceGroups" ], - "operationId": "DeviceGroups_ClaimDevices", "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": [ { @@ -2015,32 +2015,32 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Bulk claim devices request body.", + "required": true, "schema": { "$ref": "#/definitions/ClaimDevicesRequest" } @@ -2051,9 +2051,9 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, @@ -2077,10 +2077,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices": { "post": { + "operationId": "DeviceGroups_CountDevices", "tags": [ "DeviceGroups" ], - "operationId": "DeviceGroups_CountDevices", "description": "Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -2095,24 +2095,24 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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$" } @@ -2140,10 +2140,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments": { "get": { + "operationId": "Deployments_ListByDeviceGroup", "tags": [ "Deployments" ], - "operationId": "Deployments_ListByDeviceGroup", "description": "List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -2170,24 +2170,24 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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$" } @@ -2206,22 +2206,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Deployments_Get", "description": "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -2236,32 +2236,32 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, "type": "string" } ], @@ -2286,10 +2286,10 @@ } }, "put": { + "operationId": "Deployments_CreateOrUpdate", "tags": [ "Deployments" ], - "operationId": "Deployments_CreateOrUpdate", "description": "Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -2304,39 +2304,39 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "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", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Deployment" } @@ -2351,15 +2351,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Deployment" } }, "default": { @@ -2380,10 +2380,10 @@ "x-ms-long-running-operation": true }, "delete": { + "operationId": "Deployments_Delete", "tags": [ "Deployments" ], - "operationId": "Deployments_Delete", "description": "Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -2398,32 +2398,32 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, "type": "string" } ], @@ -2435,13 +2435,13 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2468,10 +2468,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices": { "get": { + "operationId": "Devices_ListByDeviceGroup", "tags": [ "Devices" ], - "operationId": "Devices_ListByDeviceGroup", "description": "List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", "parameters": [ { @@ -2486,24 +2486,24 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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$" } @@ -2522,22 +2522,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "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" ], - "operationId": "Devices_Get", "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": [ { @@ -2552,32 +2552,32 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Device name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{128}$" } @@ -2603,10 +2603,10 @@ } }, "put": { + "operationId": "Devices_CreateOrUpdate", "tags": [ "Devices" ], - "operationId": "Devices_CreateOrUpdate", "description": "Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.", "parameters": [ { @@ -2621,40 +2621,40 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Device name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{128}$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Device" } @@ -2669,15 +2669,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Device" + }, "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Device" } }, "default": { @@ -2697,12 +2697,12 @@ }, "x-ms-long-running-operation": true }, - "delete": { + "patch": { + "operationId": "Devices_Update", "tags": [ "Devices" ], - "operationId": "Devices_Delete", - "description": "Delete a Device", + "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" @@ -2716,57 +2716,62 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "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": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Device" + } }, "202": { - "description": "Resource deletion accepted.", + "description": "Resource update request accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" - }, - "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, - "204": { - "description": "Resource deleted successfully." - }, "default": { "description": "An unexpected error response.", "schema": { @@ -2775,8 +2780,8 @@ } }, "x-ms-examples": { - "Devices_Delete": { - "$ref": "./examples/DeleteDevice.json" + "Devices_Update": { + "$ref": "./examples/PatchDevice.json" } }, "x-ms-long-running-operation-options": { @@ -2784,12 +2789,12 @@ }, "x-ms-long-running-operation": true }, - "patch": { + "delete": { + "operationId": "Devices_Delete", "tags": [ "Devices" ], - "operationId": "Devices_Update", - "description": "Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.", + "description": "Delete a Device", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -2803,62 +2808,57 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Device name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{128}$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/DeviceUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/Device" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "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" + "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": { @@ -2867,8 +2867,8 @@ } }, "x-ms-examples": { - "Devices_Update": { - "$ref": "./examples/PatchDevice.json" + "Devices_Delete": { + "$ref": "./examples/DeleteDevice.json" } }, "x-ms-long-running-operation-options": { @@ -2879,10 +2879,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage": { "post": { + "operationId": "Devices_GenerateCapabilityImage", "tags": [ "Devices" ], - "operationId": "Devices_GenerateCapabilityImage", "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": [ { @@ -2897,40 +2897,40 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" }, { "name": "deviceGroupName", "in": "path", - "required": true, "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", - "required": true, "description": "Device name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{128}$" }, { "name": "generateDeviceCapabilityRequest", "in": "body", - "required": true, "description": "Generate capability image request body.", + "required": true, "schema": { "$ref": "#/definitions/GenerateCapabilityImageRequest" } @@ -2947,9 +2947,9 @@ "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" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, @@ -2973,10 +2973,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/generateDefaultDeviceGroups": { "post": { + "operationId": "Products_GenerateDefaultDeviceGroups", "tags": [ "Products" ], - "operationId": "Products_GenerateDefaultDeviceGroups", "description": "Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", "parameters": [ { @@ -2991,16 +2991,16 @@ { "name": "catalogName", "in": "path", - "required": true, "description": "Name of catalog", + "required": true, "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, { "name": "productName", "in": "path", - "required": true, "description": "Name of product.", + "required": true, "type": "string", "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" } @@ -3019,13 +3019,13 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Products_GenerateDefaultDeviceGroups": { "$ref": "./examples/PostGenerateDefaultDeviceGroups.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } } @@ -3081,6 +3081,7 @@ }, "Catalog": { "type": "object", + "description": "An Azure Sphere catalog", "properties": { "properties": { "$ref": "#/definitions/CatalogProperties", @@ -3092,7 +3093,6 @@ ] } }, - "description": "An Azure Sphere catalog", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -3101,54 +3101,52 @@ }, "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" - }, - "description": "The Catalog items on this page", - "x-typespec-name": "Catalog[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Catalog list operation.", "required": [ "value" ] }, "CatalogProperties": { "type": "object", + "description": "Catalog properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } - }, - "description": "Catalog properties" + } }, "CatalogUpdate": { "type": "object", + "description": "The type used for update operations of the Catalog.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } } - }, - "description": "The type used for update operations of the Catalog." + } }, "Certificate": { "type": "object", + "description": "An certificate resource belonging to a catalog resource.", "properties": { "properties": { "$ref": "#/definitions/CertificateProperties", @@ -3160,7 +3158,6 @@ ] } }, - "description": "An certificate resource belonging to a catalog resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -3169,40 +3166,39 @@ }, "CertificateChainResponse": { "type": "object", + "description": "The certificate chain response.", "properties": { "certificateChain": { "type": "string", "description": "The certificate chain.", "readOnly": true } - }, - "description": "The certificate chain response." + } }, "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" - }, - "description": "The Certificate items on this page", - "x-typespec-name": "Certificate[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Certificate list operation.", "required": [ "value" ] }, "CertificateProperties": { "type": "object", + "description": "The properties of certificate", "properties": { "certificate": { "type": "string", @@ -3241,8 +3237,7 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of certificate" + } }, "CertificateStatus": { "type": "string", @@ -3282,25 +3277,24 @@ }, "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" - }, - "description": "Device identifiers of the devices to be claimed.", - "x-typespec-name": "string[]" + } } }, - "description": "Request to the action call to bulk claim devices.", "required": [ "deviceIdentifiers" ] }, "CountDeviceResponse": { "type": "object", - "properties": {}, "description": "Response to the action call for count devices in a catalog.", + "properties": {}, "allOf": [ { "$ref": "#/definitions/CountElementsResponse" @@ -3309,6 +3303,7 @@ }, "CountElementsResponse": { "type": "object", + "description": "Response of the count for elements.", "properties": { "value": { "type": "integer", @@ -3316,13 +3311,13 @@ "description": "Number of children resources in parent resource." } }, - "description": "Response of the count for elements.", "required": [ "value" ] }, "Deployment": { "type": "object", + "description": "An deployment resource belonging to a device group resource.", "properties": { "properties": { "$ref": "#/definitions/DeploymentProperties", @@ -3334,7 +3329,6 @@ ] } }, - "description": "An deployment resource belonging to a device group resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -3343,29 +3337,28 @@ }, "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" - }, - "description": "The Deployment items on this page", - "x-typespec-name": "Deployment[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Deployment list operation.", "required": [ "value" ] }, "DeploymentProperties": { "type": "object", + "description": "The properties of deployment", "properties": { "deploymentId": { "type": "string", @@ -3377,11 +3370,10 @@ }, "deployedImages": { "type": "array", + "description": "Images deployed", "items": { "$ref": "#/definitions/Image" }, - "description": "Images deployed", - "x-typespec-name": "Image[]", "x-ms-mutability": [ "read", "create" @@ -3398,11 +3390,11 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of deployment" + } }, "Device": { "type": "object", + "description": "An device resource belonging to a device group resource.", "properties": { "properties": { "$ref": "#/definitions/DeviceProperties", @@ -3414,7 +3406,6 @@ ] } }, - "description": "An device resource belonging to a device group resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -3423,6 +3414,7 @@ }, "DeviceGroup": { "type": "object", + "description": "An device group resource belonging to a product resource.", "properties": { "properties": { "$ref": "#/definitions/DeviceGroupProperties", @@ -3434,7 +3426,6 @@ ] } }, - "description": "An device group resource belonging to a product resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -3443,29 +3434,28 @@ }, "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" - }, - "description": "The DeviceGroup items on this page", - "x-typespec-name": "DeviceGroup[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a DeviceGroup list operation.", "required": [ "value" ] }, "DeviceGroupProperties": { "type": "object", + "description": "The properties of deviceGroup", "properties": { "description": { "type": "string", @@ -3497,21 +3487,21 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of deviceGroup" + } }, "DeviceGroupUpdate": { "type": "object", + "description": "The type used for update operations of the DeviceGroup.", "properties": { "properties": { "$ref": "#/definitions/DeviceGroupUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the DeviceGroup." + } }, "DeviceGroupUpdateProperties": { "type": "object", + "description": "The updatable properties of the DeviceGroup.", "properties": { "description": { "type": "string", @@ -3533,11 +3523,11 @@ "$ref": "#/definitions/RegionalDataBoundary", "description": "Regional data boundary for the device group." } - }, - "description": "The updatable properties of the DeviceGroup." + } }, "DeviceInsight": { "type": "object", + "description": "Device insight report.", "properties": { "deviceId": { "type": "string", @@ -3575,7 +3565,6 @@ "description": "Event count" } }, - "description": "Device insight report.", "required": [ "deviceId", "description", @@ -3589,42 +3578,41 @@ }, "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" - }, - "description": "The Device items on this page", - "x-typespec-name": "Device[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Device list operation.", "required": [ "value" ] }, "DevicePatchProperties": { "type": "object", + "description": "The properties of device patch", "properties": { "deviceGroupId": { "type": "string", "description": "Device group id" } }, - "description": "The properties of device patch", "required": [ "deviceGroupId" ] }, "DeviceProperties": { "type": "object", + "description": "The properties of device", "properties": { "deviceId": { "type": "string", @@ -3666,48 +3654,47 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of device" + } }, "DeviceUpdate": { "type": "object", + "description": "The type used for update operations of the Device.", "properties": { "properties": { "$ref": "#/definitions/DeviceUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the Device." + } }, "DeviceUpdateProperties": { "type": "object", + "description": "The updatable properties of the Device.", "properties": { "deviceGroupId": { "type": "string", "description": "Device group id" } - }, - "description": "The updatable properties of the Device." + } }, "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" - }, - "description": "List of capabilities to create", - "x-typespec-name": "CapabilityType[]" + } } }, - "description": "Request of the action to create a signed device capability image", "required": [ "capabilities" ] }, "Image": { "type": "object", + "description": "An image resource belonging to a catalog resource.", "properties": { "properties": { "$ref": "#/definitions/ImageProperties", @@ -3719,7 +3706,6 @@ ] } }, - "description": "An image resource belonging to a catalog resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -3728,29 +3714,28 @@ }, "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" - }, - "description": "The Image items on this page", - "x-typespec-name": "Image[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Image list operation.", "required": [ "value" ] }, "ImageProperties": { "type": "object", + "description": "The properties of image", "properties": { "image": { "type": "string", @@ -3806,8 +3791,7 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of image" + } }, "ImageType": { "type": "string", @@ -3967,26 +3951,26 @@ }, "ImageUploadRequestBody": { "type": "object", + "description": "Image upload request body.", "properties": { "images": { "type": "string", "description": "." } }, - "description": "Image upload request body.", "required": [ "images" ] }, "ListDeviceGroupsRequest": { "type": "object", + "description": "Request of the action to list device groups for a catalog.", "properties": { "deviceGroupName": { "type": "string", "description": "Device Group name." } - }, - "description": "Request of the action to list device groups for a catalog." + } }, "OSFeedType": { "type": "string", @@ -4014,30 +3998,29 @@ }, "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": [], - "description": "The DeviceInsight items on this page", - "x-typespec-name": "DeviceInsight[]" + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Paged collection of DeviceInsight items", "required": [ "value" ] }, "Product": { "type": "object", + "description": "An product resource belonging to a catalog resource.", "properties": { "properties": { "$ref": "#/definitions/ProductProperties", @@ -4049,7 +4032,6 @@ ] } }, - "description": "An product resource belonging to a catalog resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -4058,29 +4040,28 @@ }, "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" - }, - "description": "The Product items on this page", - "x-typespec-name": "Product[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Product list operation.", "required": [ "value" ] }, "ProductProperties": { "type": "object", + "description": "The properties of product", "properties": { "description": { "type": "string", @@ -4092,48 +4073,47 @@ "readOnly": true } }, - "description": "The properties of product", "required": [ "description" ] }, "ProductUpdate": { "type": "object", + "description": "The type used for update operations of the Product.", "properties": { "properties": { "$ref": "#/definitions/ProductUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the Product." + } }, "ProductUpdateProperties": { "type": "object", + "description": "The updatable properties of the Product.", "properties": { "description": { "type": "string", "description": "Description of the product" } - }, - "description": "The updatable properties of the Product." + } }, "ProofOfPossessionNonceRequest": { "type": "object", + "description": "Request for the proof of possession nonce", "properties": { "proofOfPossessionNonce": { "type": "string", "description": "The proof of possession nonce" } }, - "description": "Request for the proof of possession nonce", "required": [ "proofOfPossessionNonce" ] }, "ProofOfPossessionNonceResponse": { "type": "object", - "properties": {}, "description": "Result of the action to generate a proof of possession nonce", + "properties": {}, "allOf": [ { "$ref": "#/definitions/CertificateProperties" @@ -4220,14 +4200,14 @@ }, "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 } - }, - "description": "Signed device capability image response" + } }, "UpdatePolicy": { "type": "string", @@ -4258,41 +4238,41 @@ "CustomFilterQueryParameter": { "name": "$filter", "in": "query", - "required": false, "description": "Filter the result list using the given expression", - "x-ms-client-name": "filter", + "required": false, "type": "string", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "filter" }, "CustomMaxPageSizeQueryParameter": { "name": "$maxpagesize", "in": "query", - "required": false, "description": "The maximum number of result items per page.", - "x-ms-client-name": "maxpagesize", + "required": false, "type": "integer", "format": "int32", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "maxpagesize" }, "CustomSkipQueryParameter": { "name": "$skip", "in": "query", - "required": false, "description": "The number of result items to skip.", - "x-ms-client-name": "skip", + "required": false, "type": "integer", "format": "int32", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "skip" }, "CustomTopQueryParameter": { "name": "$top", "in": "query", - "required": false, "description": "The number of result items to return.", - "x-ms-client-name": "top", + "required": false, "type": "integer", "format": "int32", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "top" } } } diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_CreateOrUpdate.json new file mode 100644 index 000000000000..fe93886dae2a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_CreateOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "agent": { + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "description": "Example Agent Description", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents", + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "description": "Example Agent Description", + "agentVersion": "1.0.0", + "agentStatus": "Registering", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "lastStatusUpdate": null, + "localIPAddress": null, + "memoryInMB": null, + "numberOfCores": null, + "uptimeInSeconds": null, + "errorDetails": null + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Delete.json new file mode 100644 index 000000000000..62865e611500 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Get.json new file mode 100644 index 000000000000..917e243a26d2 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "description": "Example Agent Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 100024, + "numberOfCores": 32, + "uptimeInSeconds": 522, + "errorDetails": null + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_List.json new file mode 100644 index 000000000000..f1912ca2f813 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_List.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName1", + "name": "examples-agentName1", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName1", + "description": "Example Agent 1 Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 100024, + "numberOfCores": 32, + "uptimeInSeconds": 522, + "errorDetails": null + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName2", + "name": "examples-agentName2", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName2", + "description": "Example Agent 2 Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "147a1f84-7bbf-4e99-9a6a-a1735a91dfd5", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 100024, + "numberOfCores": 32, + "uptimeInSeconds": 522, + "errorDetails": null + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName3", + "name": "examples-agentName3", + "type": "Microsoft.StorageMover/storageMovers/agents", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName3", + "description": "Example Agent 3 Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "648a7958-f99e-4268-b20e-94c96558dc0d", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 100024, + "numberOfCores": 32, + "uptimeInSeconds": 522, + "errorDetails": { + "code": "SampleErrorCode", + "message": "Detailed sample error message." + } + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Update.json new file mode 100644 index 000000000000..f8d527dfb83e --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Agents_Update.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "agentName": "examples-agentName", + "agent": { + "properties": { + "description": "Updated Agent Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName", + "name": "examples-agentName", + "type": "Microsoft.StorageMover/storageMovers/agents", + "properties": { + "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName", + "description": "Updated Agent Description", + "agentVersion": "1.0.0", + "agentStatus": "Online", + "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9", + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "localIPAddress": "192.168.0.0", + "memoryInMB": 100024, + "numberOfCores": 32, + "uptimeInSeconds": 522, + "errorDetails": null + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json new file mode 100644 index 000000000000..4c2d34370222 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json @@ -0,0 +1,35 @@ +{ + "title": "Endpoints_CreateOrUpdate_AzureStorageBlobContainer", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Example Storage Blob Container Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Example Storage Blob Container Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json new file mode 100644 index 000000000000..079b218f5cd7 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json @@ -0,0 +1,35 @@ +{ + "title": "Endpoints_CreateOrUpdate_AzureStorageSmbFileShare", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Example Storage File Share Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Example Storage File Share Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_NfsMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_NfsMount.json new file mode 100644 index 000000000000..2f74a442ac88 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_NfsMount.json @@ -0,0 +1,36 @@ +{ + "title": "Endpoints_CreateOrUpdate_NfsMount", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "description": "Example NFS Mount Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "nfsVersion": "NFSauto", + "description": "Example NFS Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_SmbMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_SmbMount.json new file mode 100644 index 000000000000..3ba99281905a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_CreateOrUpdate_SmbMount.json @@ -0,0 +1,45 @@ +{ + "title": "Endpoints_CreateOrUpdate_SmbMount", + "operationId": "Endpoints_CreateOrUpdate", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-password" + }, + "description": "Example SMB Mount Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-password" + }, + "description": "Example SMB Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..a01552961a0b --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_AzureStorageBlobContainer.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_AzureStorageBlobContainer.json new file mode 100644 index 000000000000..6a7cdce48a10 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_AzureStorageBlobContainer.json @@ -0,0 +1,27 @@ +{ + "title": "Endpoints_Get_AzureStorageBlobContainer", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Example Storage Blob Container Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_AzureStorageSmbFileShare.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_AzureStorageSmbFileShare.json new file mode 100644 index 000000000000..5d358eb4461e --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_AzureStorageSmbFileShare.json @@ -0,0 +1,27 @@ +{ + "title": "Endpoints_Get_AzureStorageSmbFileShare", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Example Storage File Share Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_NfsMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_NfsMount.json new file mode 100644 index 000000000000..4e093f760edb --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_NfsMount.json @@ -0,0 +1,28 @@ +{ + "title": "Endpoints_Get_NfsMount", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "nfsVersion": "NFSauto", + "description": "Example NFS Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_SmbMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_SmbMount.json new file mode 100644 index 000000000000..2a269e7f8c49 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Get_SmbMount.json @@ -0,0 +1,32 @@ +{ + "title": "Endpoints_Get_SmbMount", + "operationId": "Endpoints_Get", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-password" + }, + "description": "Example SMB Mount Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_List.json new file mode 100644 index 000000000000..c3b63af94cc9 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_List.json @@ -0,0 +1,56 @@ +{ + "title": "Endpoints_List", + "operationId": "Endpoints_List", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName1", + "name": "examples-endpointName1", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer1", + "description": "Example Storage Container Endpoint 1 Description", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName2", + "name": "examples-endpointName2", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "nfsVersion": "NFSv4", + "description": "Example Storage Container Endpoint 2 Description", + "export": "/", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName3", + "name": "examples-endpointName3", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer3", + "description": "Example Storage Container Endpoint 3 Description", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_AzureStorageBlobContainer.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_AzureStorageBlobContainer.json new file mode 100644 index 000000000000..30ec1db14421 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_AzureStorageBlobContainer.json @@ -0,0 +1,33 @@ +{ + "title": "Endpoints_Update_AzureStorageBlobContainer", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageBlobContainer", + "description": "Updated Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageBlobContainer", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "blobContainerName": "examples-blobcontainer", + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_AzureStorageSmbFileShare.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_AzureStorageSmbFileShare.json new file mode 100644 index 000000000000..ec300292d1fc --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_AzureStorageSmbFileShare.json @@ -0,0 +1,33 @@ +{ + "title": "Endpoints_Update_AzureStorageSmbFileShare", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "description": "Updated Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "AzureStorageSmbFileShare", + "storageAccountResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.Storage/storageAccounts/examplesa", + "fileShareName": "examples-fileshare", + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_NfsMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_NfsMount.json new file mode 100644 index 000000000000..0148f0b539f2 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_NfsMount.json @@ -0,0 +1,34 @@ +{ + "title": "Endpoints_Update_NfsMount", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "NfsMount", + "description": "Updated Endpoint Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "NfsMount", + "host": "0.0.0.0", + "export": "examples-exportName", + "nfsVersion": "NFSauto", + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_SmbMount.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_SmbMount.json new file mode 100644 index 000000000000..cc6baaab8066 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Endpoints_Update_SmbMount.json @@ -0,0 +1,43 @@ +{ + "title": "Endpoints_Update_SmbMount", + "operationId": "Endpoints_Update", + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "endpointName": "examples-endpointName", + "endpoint": { + "properties": { + "endpointType": "SmbMount", + "description": "Updated Endpoint Description", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-password" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-endpointName", + "name": "examples-endpointName", + "type": "Microsoft.StorageMover/storageMovers/endpoints", + "properties": { + "endpointType": "SmbMount", + "host": "0.0.0.0", + "shareName": "examples-shareName", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-username", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/examples-updated-password" + }, + "description": "Updated Endpoint Description", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_CreateOrUpdate.json new file mode 100644 index 000000000000..e64e4022c9ef --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_CreateOrUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "jobDefinition": { + "properties": { + "description": "Example Job Definition Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName", + "targetSubpath": "/", + "agentName": "migration-agent" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName", + "name": "examples-jobDefinitionName", + "type": "Microsoft.StorageMover/storageMovers/projectName/jobDefinitionName", + "properties": { + "description": "Example Job Definition Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Delete.json new file mode 100644 index 000000000000..aee99f322c7a --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Get.json new file mode 100644 index 000000000000..9282bbc25db7 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName", + "name": "examples-jobDefinitionName", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "properties": { + "description": "Example Job Definition Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_List.json new file mode 100644 index 000000000000..c1997c180567 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_List.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName1", + "name": "examples-jobDefinitionName1", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "properties": { + "description": "Example Job Definition 1 Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName1", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName1", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName1", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName1", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName2", + "name": "examples-jobDefinitionName2", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Job Definition 2 Description", + "copyMode": "Additive", + "sourceName": "examples-sourceEndpointName2", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName2", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName2", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName2", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName3", + "name": "examples-jobDefinitionName3", + "type": "Microsoft.StorageMover/storageMovers/jobDefinitions", + "properties": { + "description": "Example Job Definition 3 Description", + "copyMode": "Mirror", + "sourceName": "examples-sourceEndpointName3", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-sourceEndpointName3", + "sourceSubpath": "/", + "targetName": "examples-targetEndpointName3", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/examples-targetEndpointName3", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/jobDefinitions?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_StartJob.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_StartJob.json new file mode 100644 index 000000000000..1917dae50efa --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_StartJob.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": { + "body": { + "jobRunResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName/jobRuns/examples-jobRunName" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_StopJob.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_StopJob.json new file mode 100644 index 000000000000..1917dae50efa --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_StopJob.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName" + }, + "responses": { + "200": { + "body": { + "jobRunResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/jobDefinitions/examples-jobDefinitionName/jobRuns/examples-jobRunName" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Update.json new file mode 100644 index 000000000000..e897dd563cec --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobDefinitions_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "jobDefinition": { + "properties": { + "description": "Updated Job Definition Description", + "agentName": "updatedAgentName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName", + "name": "examples-jobDefinitionName", + "type": "Microsoft.StorageMover/storageMovers/projectName/jobDefinitionName", + "properties": { + "description": "Updated Job Definition Description", + "copyMode": "Additive", + "sourceName": "updatedSource", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/updatedSource", + "sourceSubpath": "/", + "targetName": "updatedTarget", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/updatedTarget", + "targetSubpath": "/", + "latestJobRunName": null, + "latestJobRunResourceId": null, + "latestJobRunStatus": null, + "agentName": "updatedAgentName", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobRuns_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobRuns_Get.json new file mode 100644 index 000000000000..6b2a5572ef8d --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobRuns_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "jobRunName": "examples-jobRunName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName/jobDefinitions/examples-jobDefinitionName/jobRuns/examples-jobRunName", + "name": "examples-jobRunName", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Running", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobRuns_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobRuns_List.json new file mode 100644 index 000000000000..37ee2990c3a2 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/JobRuns_List.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "jobDefinitionName": "examples-jobDefinitionName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName1", + "name": "examples-jobRunName1", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Running", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName2", + "name": "examples-jobRunName2", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Failed", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projectName/examples-projectName/jobDefinitions/examples-jobDefinitionName1/jobRuns/examples-jobRunName3", + "name": "examples-jobRunName3", + "type": "Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns", + "properties": { + "status": "Failed", + "scanStatus": "Scanning", + "agentName": "migration-agent", + "agentResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/migration-agent", + "executionStartTime": "2023-07-01T02:11:01.1075056Z", + "executionEndTime": null, + "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z", + "sourceName": "sourceEndpoint", + "sourceResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/sourceEndpoint", + "sourceProperties": {}, + "targetName": "targetEndpoint", + "targetResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/endpoints/targetEndpoint", + "targetProperties": {}, + "jobDefinitionProperties": {}, + "itemsScanned": 351, + "itemsExcluded": 50, + "itemsUnsupported": 27, + "itemsNoTransferNeeded": 150, + "itemsFailed": 3, + "itemsTransferred": 100, + "bytesScanned": 49951162777600, + "bytesExcluded": 995116277760, + "bytesUnsupported": 495116277760, + "bytesNoTransferNeeded": 2995116277760, + "bytesFailed": 5116277760, + "bytesTransferred": 1995116277760 + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/projects/jobDefinitions/jobRuns?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Operations_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..16a8713ee8b5 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StorageMover/storageMovers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft StorageMover", + "resource": "StorageMovers", + "operation": "Get or List StorageMover resource(s).", + "description": "Gets or Lists existing StorageMover resource(s)." + } + }, + { + "name": "Microsoft.StorageMover/storageMovers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft StorageMover", + "resource": "StorageMovers", + "operation": "Create or Update StorageMover resource.", + "description": "Creates or Updates StorageMover resource." + } + }, + { + "name": "Microsoft.StorageMover/storageMovers/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft StorageMover", + "resource": "StorageMovers", + "operation": "Delete StorageMover resource.", + "description": "Deletes StorageMover resource." + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/operations?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_CreateOrUpdate.json new file mode 100644 index 000000000000..56d0271b735e --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_CreateOrUpdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "project": { + "properties": { + "description": "Example Project Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName", + "name": "examples-projectName", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Delete.json new file mode 100644 index 000000000000..6e1d0a05f5f1 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Get.json new file mode 100644 index 000000000000..644ec0c21ffc --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName", + "name": "examples-projectName", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_List.json new file mode 100644 index 000000000000..05643487b7bd --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName1", + "name": "examples-projectName1", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project 1 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName2", + "name": "examples-projectName2", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project 2 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/projects/examples-projectName2", + "name": "examples-projectName3", + "type": "Microsoft.StorageMover/storageMovers/projects", + "properties": { + "description": "Example Project 3 Description" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers/projects?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Update.json new file mode 100644 index 000000000000..e3a830236c9c --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/Projects_Update.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "projectName": "examples-projectName", + "project": { + "properties": { + "description": "Example Project Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-projectName", + "name": "examples-projectName", + "type": "Microsoft.StorageMover/storageMovers/projectName", + "properties": { + "description": "Example Project Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_CreateOrUpdate.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_CreateOrUpdate.json new file mode 100644 index 000000000000..c50d7814c9f1 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_CreateOrUpdate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "storageMover": { + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "description": "Example Storage Mover Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName", + "name": "examples-storageMoverName", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Delete.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Delete.json new file mode 100644 index 000000000000..25408b0dbbbe --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/providers/Microsoft.StorageMover/operationResults/delete0", + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.StorageMover/operationStatuses/delete0" + } + }, + "204": {} + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Get.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Get.json new file mode 100644 index 000000000000..81d35ef8dfbf --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName", + "name": "examples-storageMoverName", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_List.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_List.json new file mode 100644 index 000000000000..bc5163dc58cf --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName1", + "name": "examples-storageMoverResourceName1", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 1 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName2", + "name": "examples-storageMoverResourceName2", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 2 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName3", + "name": "examples-storageMoverResourceName3", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 3 Description" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_ListBySubscription.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_ListBySubscription.json new file mode 100644 index 000000000000..09f47736af2d --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_ListBySubscription.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName1", + "name": "examples-storageMoverResourceName1", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 1 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg2/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName2", + "name": "examples-storageMoverResourceName2", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 2 Description" + } + }, + { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverResourceName3", + "name": "examples-storageMoverResourceName3", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Example Storage Mover 3 Description" + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.StorageMover/storageMovers?$skiptoken={token}" + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Update.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Update.json new file mode 100644 index 000000000000..e00ad8185016 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/examples/StorageMovers_Update.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-07-01-preview", + "subscriptionId": "60bcfc77-6589-4da2-b7fd-f9ec9322cf95", + "resourceGroupName": "examples-rg", + "storageMoverName": "examples-storageMoverName", + "storageMover": { + "properties": { + "description": "Updated Storage Mover Description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName", + "name": "examples-storageMoverName", + "type": "Microsoft.StorageMover/storageMovers", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2023-07-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-07-01T02:01:01.1075056Z" + }, + "properties": { + "description": "Updated Storage Mover Description" + } + } + } + } +} diff --git a/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/storagemover.json b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/storagemover.json new file mode 100644 index 000000000000..6a5329c15119 --- /dev/null +++ b/specification/storagemover/resource-manager/Microsoft.StorageMover/preview/2023-07-01-preview/storagemover.json @@ -0,0 +1,2762 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-07-01-preview", + "title": "StorageMoverClient", + "description": "The Azure Storage Mover 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.StorageMover/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all the supported operations for the Azure Storage Mover REST API.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of supported 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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageMover/storageMovers": { + "get": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_ListBySubscription", + "description": "Lists all Storage Movers in a subscription.", + "x-ms-examples": { + "StorageMovers_List": { + "$ref": "./examples/StorageMovers_ListBySubscription.json" + } + }, + "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 list of Storage Movers.", + "schema": { + "$ref": "#/definitions/StorageMoverList" + } + }, + "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.StorageMover/storageMovers": { + "get": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_List", + "description": "Lists all Storage Movers in a resource group.", + "x-ms-examples": { + "StorageMovers_List": { + "$ref": "./examples/StorageMovers_List.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": { + "200": { + "description": "The list of Storage Movers.", + "schema": { + "$ref": "#/definitions/StorageMoverList" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}": { + "get": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_Get", + "description": "Gets a Storage Mover resource.", + "x-ms-examples": { + "StorageMovers_Get": { + "$ref": "./examples/StorageMovers_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Storage Mover resource.", + "schema": { + "$ref": "#/definitions/StorageMover" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_CreateOrUpdate", + "description": "Creates or updates a top-level Storage Mover resource.", + "x-ms-examples": { + "StorageMovers_CreateOrUpdate": { + "$ref": "./examples/StorageMovers_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "storageMover", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMover" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Storage Mover resource.", + "schema": { + "$ref": "#/definitions/StorageMover" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_Update", + "description": "Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "StorageMovers_Update": { + "$ref": "./examples/StorageMovers_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "storageMover", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageMoverUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Storage Mover resource.", + "schema": { + "$ref": "#/definitions/StorageMover" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "StorageMovers" + ], + "operationId": "StorageMovers_Delete", + "description": "Deletes a Storage Mover resource.", + "x-ms-examples": { + "StorageMovers_Delete": { + "$ref": "./examples/StorageMovers_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/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Storage Mover." + }, + "202": { + "description": "Accepted. Storage Mover delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Storage Mover does not exist in the subscription." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents": { + "get": { + "tags": [ + "Agents" + ], + "operationId": "Agents_List", + "description": "Lists all Agents in a Storage Mover.", + "x-ms-examples": { + "Agents_List": { + "$ref": "./examples/Agents_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/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Agents.", + "schema": { + "$ref": "#/definitions/AgentList" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}": { + "get": { + "tags": [ + "Agents" + ], + "operationId": "Agents_Get", + "description": "Gets an Agent resource.", + "x-ms-examples": { + "Agents_Get": { + "$ref": "./examples/Agents_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Agent resource.", + "schema": { + "$ref": "#/definitions/Agent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Agents" + ], + "operationId": "Agents_CreateOrUpdate", + "description": "Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.", + "x-ms-examples": { + "Agents_CreateOrUpdate": { + "$ref": "./examples/Agents_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "agent", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Agent" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Agent resource.", + "schema": { + "$ref": "#/definitions/Agent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Agents" + ], + "operationId": "Agents_Update", + "description": "Creates or updates an Agent resource.", + "x-ms-examples": { + "Agents_Update": { + "$ref": "./examples/Agents_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "agent", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Agent resource.", + "schema": { + "$ref": "#/definitions/Agent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Agents" + ], + "operationId": "Agents_Delete", + "description": "Deletes an Agent resource.", + "x-ms-examples": { + "Agents_Delete": { + "$ref": "./examples/Agents_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/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/AgentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Agent." + }, + "202": { + "description": "Accepted. Agent delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Agent does not exist for this Storage Mover." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_List", + "description": "Lists all Endpoints in a Storage Mover.", + "x-ms-examples": { + "Endpoints_List": { + "$ref": "./examples/Endpoints_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/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Endpoints.", + "schema": { + "$ref": "#/definitions/EndpointList" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Get", + "description": "Gets an Endpoint resource.", + "x-ms-examples": { + "Endpoints_Get_AzureStorageBlobContainer": { + "$ref": "./examples/Endpoints_Get_AzureStorageBlobContainer.json" + }, + "Endpoints_Get_AzureStorageSmbFileShare": { + "$ref": "./examples/Endpoints_Get_AzureStorageSmbFileShare.json" + }, + "Endpoints_Get_NfsMount": { + "$ref": "./examples/Endpoints_Get_NfsMount.json" + }, + "Endpoints_Get_SmbMount": { + "$ref": "./examples/Endpoints_Get_SmbMount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Endpoint resource.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_CreateOrUpdate", + "description": "Creates or updates an Endpoint resource, which represents a data transfer source or destination.", + "x-ms-examples": { + "Endpoints_CreateOrUpdate_AzureStorageBlobContainer": { + "$ref": "./examples/Endpoints_CreateOrUpdate_AzureStorageBlobContainer.json" + }, + "Endpoints_CreateOrUpdate_AzureStorageSmbFileShare": { + "$ref": "./examples/Endpoints_CreateOrUpdate_AzureStorageSmbFileShare.json" + }, + "Endpoints_CreateOrUpdate_NfsMount": { + "$ref": "./examples/Endpoints_CreateOrUpdate_NfsMount.json" + }, + "Endpoints_CreateOrUpdate_SmbMount": { + "$ref": "./examples/Endpoints_CreateOrUpdate_SmbMount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "endpoint", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Endpoint resource.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Update", + "description": "Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "Endpoints_Update_AzureStorageBlobContainer": { + "$ref": "./examples/Endpoints_Update_AzureStorageBlobContainer.json" + }, + "Endpoints_Update_AzureStorageSmbFileShare": { + "$ref": "./examples/Endpoints_Update_AzureStorageSmbFileShare.json" + }, + "Endpoints_Update_NfsMount": { + "$ref": "./examples/Endpoints_Update_NfsMount.json" + }, + "Endpoints_Update_SmbMount": { + "$ref": "./examples/Endpoints_Update_SmbMount.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "endpoint", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointBaseUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Endpoint resource.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "operationId": "Endpoints_Delete", + "description": "Deletes an Endpoint resource.", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_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/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/EndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Endpoint." + }, + "202": { + "description": "Accepted. Endpoint delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Endpoint does not exist for this Storage Mover." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects": { + "get": { + "tags": [ + "Projects" + ], + "operationId": "Projects_List", + "description": "Lists all Projects in a Storage Mover.", + "x-ms-examples": { + "Projects_List": { + "$ref": "./examples/Projects_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/StorageMoverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Projects.", + "schema": { + "$ref": "#/definitions/ProjectList" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "operationId": "Projects_Get", + "description": "Gets a Project resource.", + "x-ms-examples": { + "Projects_Get": { + "$ref": "./examples/Projects_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Project resource.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "operationId": "Projects_CreateOrUpdate", + "description": "Creates or updates a Project resource, which is a logical grouping of related jobs.", + "x-ms-examples": { + "Projects_CreateOrUpdate": { + "$ref": "./examples/Projects_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "project", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Project resource.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "operationId": "Projects_Update", + "description": "Updates properties for a Project resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "Projects_Update": { + "$ref": "./examples/Projects_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "project", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Project resource.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "operationId": "Projects_Delete", + "description": "Deletes a Project resource.", + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/Projects_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/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Project." + }, + "202": { + "description": "Accepted. Project delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Project does not exist for this Storage Mover." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions": { + "get": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_List", + "description": "Lists all Job Definitions in a Project.", + "x-ms-examples": { + "JobDefinitions_List": { + "$ref": "./examples/JobDefinitions_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/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Job Definitions.", + "schema": { + "$ref": "#/definitions/JobDefinitionList" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}": { + "get": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_Get", + "description": "Gets a Job Definition resource.", + "x-ms-examples": { + "JobDefinitions_Get": { + "$ref": "./examples/JobDefinitions_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Job Definition resource.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_CreateOrUpdate", + "description": "Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.", + "x-ms-examples": { + "JobDefinitions_CreateOrUpdate": { + "$ref": "./examples/JobDefinitions_CreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "jobDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + ], + "responses": { + "200": { + "description": "Successfully PUT Job Definition resource.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_Update", + "description": "Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.", + "x-ms-examples": { + "JobDefinitions_Update": { + "$ref": "./examples/JobDefinitions_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "jobDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinitionUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Job Definition resource.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_Delete", + "description": "Deletes a Job Definition resource.", + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/JobDefinitions_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/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted Job Definition." + }, + "202": { + "description": "Accepted. Job Definition delete operation is ongoing." + }, + "204": { + "description": "NoContent -- Job Definition does not exist for this Project." + }, + "default": { + "description": "Error response describing why delete operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/startJob": { + "post": { + "consumes": [ + "application/json", + "application/x-www-form-urlencoded" + ], + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_StartJob", + "description": "Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource.", + "x-ms-examples": { + "JobDefinitions_StartJob": { + "$ref": "./examples/JobDefinitions_StartJob.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested job to start.", + "schema": { + "$ref": "#/definitions/JobRunResourceId" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/stopJob": { + "post": { + "consumes": [ + "application/json", + "application/x-www-form-urlencoded" + ], + "tags": [ + "JobDefinitions" + ], + "operationId": "JobDefinitions_StopJob", + "description": "Requests the Agent of any active instance of this Job Definition to stop.", + "x-ms-examples": { + "JobDefinitions_StopJob": { + "$ref": "./examples/JobDefinitions_StopJob.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested running job to stop, if any.", + "schema": { + "$ref": "#/definitions/JobRunResourceId" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns": { + "get": { + "tags": [ + "JobRuns" + ], + "operationId": "JobRuns_List", + "description": "Lists all Job Runs in a Job Definition.", + "x-ms-examples": { + "JobRuns_List": { + "$ref": "./examples/JobRuns_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/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Job Runs.", + "schema": { + "$ref": "#/definitions/JobRunList" + } + }, + "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.StorageMover/storageMovers/{storageMoverName}/projects/{projectName}/jobDefinitions/{jobDefinitionName}/jobRuns/{jobRunName}": { + "get": { + "tags": [ + "JobRuns" + ], + "operationId": "JobRuns_Get", + "description": "Gets a Job Run resource.", + "x-ms-examples": { + "JobRuns_Get": { + "$ref": "./examples/JobRuns_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageMoverNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/JobDefinitionNameParameter" + }, + { + "$ref": "#/parameters/JobRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Job Run resource.", + "schema": { + "$ref": "#/definitions/JobRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AgentProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Agent." + }, + "agentVersion": { + "type": "string", + "description": "The Agent version.", + "readOnly": true + }, + "arcResourceId": { + "type": "string", + "description": "The fully qualified resource ID of the Hybrid Compute resource for the Agent.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "arcVmUuid": { + "type": "string", + "description": "The VM UUID of the Hybrid Compute resource for the Agent.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentStatus": { + "description": "The Agent status.", + "enum": [ + "Registering", + "Offline", + "Online", + "Executing", + "RequiresAttention", + "Unregistering" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentStatus", + "modelAsString": true + }, + "readOnly": true + }, + "lastStatusUpdate": { + "type": "string", + "format": "date-time", + "description": "The last updated time of the Agent status.", + "readOnly": true + }, + "localIPAddress": { + "type": "string", + "description": "Local IP address reported by the Agent.", + "readOnly": true + }, + "memoryInMB": { + "type": "integer", + "format": "int64", + "description": "Available memory reported by the Agent, in MB.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int64", + "description": "Available compute cores reported by the Agent.", + "readOnly": true + }, + "uptimeInSeconds": { + "type": "integer", + "format": "int64", + "description": "Uptime of the Agent in seconds.", + "readOnly": true + }, + "errorDetails": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Error code reported by Agent" + }, + "message": { + "type": "string", + "description": "Expanded description of reported error code" + } + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "enum": [ + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ + "arcResourceId", + "arcVmUuid" + ] + }, + "Agent": { + "description": "The Agent resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AgentProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AgentUpdateProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Agent." + } + } + }, + "AgentUpdateParameters": { + "description": "The Agent resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AgentUpdateProperties" + } + } + }, + "AgentList": { + "description": "List of Agents.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Agent" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "StorageMoverProperties": { + "description": "The resource specific properties for the Storage Mover resource.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Storage Mover." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "enum": [ + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "StorageMover": { + "description": "The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageMoverProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "StorageMoverUpdateProperties": { + "description": "The resource specific properties for the Storage Mover resource.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Storage Mover." + } + } + }, + "StorageMoverUpdateParameters": { + "description": "The Storage Mover resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageMoverUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + } + }, + "StorageMoverList": { + "description": "List of Storage Movers.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMover" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "EndpointBaseProperties": { + "description": "The resource specific properties for the Storage Mover resource.", + "type": "object", + "discriminator": "endpointType", + "properties": { + "endpointType": { + "description": "The Endpoint resource type.", + "$ref": "#/definitions/EndpointType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "A description for the Endpoint." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "enum": [ + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ + "endpointType" + ] + }, + "Endpoint": { + "description": "The Endpoint resource, which contains information about file sources and targets.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EndpointBaseProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "EndpointBaseUpdateProperties": { + "description": "The Endpoint resource, which contains information about file sources and targets.", + "type": "object", + "discriminator": "endpointType", + "properties": { + "endpointType": { + "description": "The Endpoint resource type.", + "$ref": "#/definitions/EndpointType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "A description for the Endpoint." + } + }, + "required": [ + "endpointType" + ] + }, + "EndpointBaseUpdateParameters": { + "description": "The Endpoint resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + } + }, + "EndpointList": { + "description": "List of Endpoints.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "AzureStorageBlobContainerEndpointProperties": { + "type": "object", + "description": "The properties of Azure Storage blob container endpoint.", + "x-ms-discriminator-value": "AzureStorageBlobContainer", + "properties": { + "storageAccountResourceId": { + "description": "The Azure Resource ID of the storage account that is the target destination.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "blobContainerName": { + "description": "The name of the Storage blob container that is the target destination.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "storageAccountResourceId", + "blobContainerName" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "AzureStorageBlobContainerEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "AzureStorageBlobContainer", + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "NfsMountEndpointProperties": { + "type": "object", + "description": "The properties of NFS share endpoint.", + "x-ms-discriminator-value": "NfsMount", + "properties": { + "host": { + "description": "The host name or IP address of the server exporting the file system.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nfsVersion": { + "description": "The NFS protocol version.", + "enum": [ + "NFSauto", + "NFSv3", + "NFSv4" + ], + "type": "string", + "x-ms-enum": { + "name": "NfsVersion", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "export": { + "description": "The directory being exported from the server.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "host", + "export" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "NfsMountEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "NfsMount", + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "AzureStorageSmbFileShareEndpointProperties": { + "type": "object", + "description": "The properties of Azure Storage SMB file share endpoint.", + "x-ms-discriminator-value": "AzureStorageSmbFileShare", + "properties": { + "storageAccountResourceId": { + "description": "The Azure Resource ID of the storage account.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "fileShareName": { + "description": "The name of the Azure Storage file share.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "storageAccountResourceId", + "fileShareName" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "AzureStorageSmbFileShareEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "AzureStorageSmbFileShare", + "description": "The properties of Azure Storage SMB file share endpoint to update.", + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "SmbMountEndpointProperties": { + "type": "object", + "description": "The properties of SMB share endpoint.", + "x-ms-discriminator-value": "SmbMount", + "properties": { + "host": { + "description": "The host name or IP address of the server exporting the file system.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "shareName": { + "description": "The name of the SMB share being exported from the server.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "credentials": { + "description": "The Azure Key Vault secret URIs which store the required credentials to access the SMB share.", + "$ref": "#/definitions/AzureKeyVaultSmbCredentials" + } + }, + "required": [ + "host", + "shareName" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseProperties" + } + ] + }, + "SmbMountEndpointUpdateProperties": { + "type": "object", + "x-ms-discriminator-value": "SmbMount", + "description": "The properties of SMB share endpoint to update.", + "properties": { + "credentials": { + "description": "The Azure Key Vault secret URIs which store the required credentials to access the SMB share.", + "$ref": "#/definitions/AzureKeyVaultSmbCredentials" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EndpointBaseUpdateProperties" + } + ] + }, + "EndpointType": { + "description": "The Endpoint resource type.", + "enum": [ + "AzureStorageBlobContainer", + "NfsMount", + "AzureStorageSmbFileShare", + "SmbMount" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "CredentialType": { + "description": "The Credentials type.", + "enum": [ + "AzureKeyVaultSmb" + ], + "type": "string", + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true + } + }, + "Credentials": { + "description": "The Credentials.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "The Credentials type.", + "$ref": "#/definitions/CredentialType", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "type" + ] + }, + "AzureKeyVaultSmbCredentials": { + "description": "The Azure Key Vault secret URIs which store the credentials.", + "type": "object", + "x-ms-discriminator-value": "AzureKeyVaultSmb", + "properties": { + "usernameUri": { + "description": "The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.", + "type": "string" + }, + "passwordUri": { + "description": "The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Credentials" + } + ] + }, + "JobDefinitionProperties": { + "description": "Job definition properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Job Definition." + }, + "copyMode": { + "type": "string", + "description": "Strategy to use for copy.", + "x-ms-enum": { + "name": "CopyMode", + "modelAsString": true + }, + "enum": [ + "Additive", + "Mirror" + ] + }, + "sourceName": { + "type": "string", + "description": "The name of the source Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sourceResourceId": { + "type": "string", + "description": "Fully qualified resource ID of the source Endpoint.", + "readOnly": true + }, + "sourceSubpath": { + "type": "string", + "description": "The subpath to use when reading from the source Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetName": { + "type": "string", + "description": "The name of the target Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Fully qualified resource ID of the target Endpoint.", + "readOnly": true + }, + "targetSubpath": { + "type": "string", + "description": "The subpath to use when writing to the target Endpoint.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "latestJobRunName": { + "type": "string", + "description": "The name of the Job Run in a non-terminal state, if exists.", + "readOnly": true + }, + "latestJobRunResourceId": { + "type": "string", + "description": "The fully qualified resource ID of the Job Run in a non-terminal state, if exists.", + "readOnly": true + }, + "latestJobRunStatus": { + "enum": [ + "Queued", + "Started", + "Running", + "CancelRequested", + "Canceling", + "Canceled", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "JobRunStatus", + "modelAsString": true + }, + "description": "The current status of the Job Run in a non-terminal state, if exists.", + "readOnly": true + }, + "agentName": { + "type": "string", + "description": "Name of the Agent to assign for new Job Runs of this Job Definition." + }, + "agentResourceId": { + "type": "string", + "description": "Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "enum": [ + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ + "copyMode", + "sourceName", + "targetName" + ] + }, + "JobDefinition": { + "description": "The Job Definition resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobDefinitionProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "JobDefinitionUpdateProperties": { + "description": "Job definition properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Job Definition." + }, + "copyMode": { + "type": "string", + "description": "Strategy to use for copy.", + "x-ms-enum": { + "name": "CopyMode", + "modelAsString": true + }, + "enum": [ + "Additive", + "Mirror" + ] + }, + "agentName": { + "type": "string", + "description": "Name of the Agent to assign for new Job Runs of this Job Definition." + } + } + }, + "JobDefinitionUpdateParameters": { + "description": "The Job Definition resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobDefinitionUpdateProperties" + } + } + }, + "JobDefinitionList": { + "description": "List of Job Definitions.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDefinition" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "JobRunError": { + "type": "object", + "description": "Error type", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "target": { + "type": "string", + "description": "Target of the given error entry." + } + } + }, + "JobRunProperties": { + "description": "Job run properties.", + "type": "object", + "properties": { + "status": { + "readOnly": true, + "enum": [ + "Queued", + "Started", + "Running", + "CancelRequested", + "Canceling", + "Canceled", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "JobRunStatus", + "modelAsString": true + }, + "description": "The state of the job execution." + }, + "scanStatus": { + "readOnly": true, + "enum": [ + "NotStarted", + "Scanning", + "Completed" + ], + "type": "string", + "x-ms-enum": { + "name": "JobRunScanStatus", + "modelAsString": true + }, + "description": "The status of Agent's scanning of source." + }, + "agentName": { + "readOnly": true, + "type": "string", + "description": "Name of the Agent assigned to this run." + }, + "agentResourceId": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource id of the Agent assigned to this run." + }, + "executionStartTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the run. Null if no Agent reported that the job has started." + }, + "executionEndTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the run. Null if Agent has not reported that the job has ended." + }, + "lastStatusUpdate": { + "type": "string", + "format": "date-time", + "description": "The last updated time of the Job Run.", + "readOnly": true + }, + "itemsScanned": { + "type": "integer", + "format": "int64", + "description": "Number of items scanned so far in source.", + "readOnly": true + }, + "itemsExcluded": { + "type": "integer", + "format": "int64", + "description": "Number of items that will not be transferred, as they are excluded by user configuration.", + "readOnly": true + }, + "itemsUnsupported": { + "type": "integer", + "format": "int64", + "description": "Number of items that will not be transferred, as they are unsupported on target.", + "readOnly": true + }, + "itemsNoTransferNeeded": { + "type": "integer", + "format": "int64", + "description": "Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).", + "readOnly": true + }, + "itemsFailed": { + "type": "integer", + "format": "int64", + "description": "Number of items that were attempted to transfer and failed.", + "readOnly": true + }, + "itemsTransferred": { + "type": "integer", + "format": "int64", + "description": "Number of items successfully transferred to target.", + "readOnly": true + }, + "bytesScanned": { + "type": "integer", + "format": "int64", + "description": "Bytes of data scanned so far in source.", + "readOnly": true + }, + "bytesExcluded": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that will not be transferred, as they are excluded by user configuration.", + "readOnly": true + }, + "bytesUnsupported": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that will not be transferred, as they are unsupported on target.", + "readOnly": true + }, + "bytesNoTransferNeeded": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).", + "readOnly": true + }, + "bytesFailed": { + "type": "integer", + "format": "int64", + "description": "Bytes of data that were attempted to transfer and failed.", + "readOnly": true + }, + "bytesTransferred": { + "type": "integer", + "format": "int64", + "description": "Bytes of data successfully transferred to target.", + "readOnly": true + }, + "sourceName": { + "type": "string", + "description": "Name of source Endpoint resource. This resource may no longer exist.", + "readOnly": true + }, + "sourceResourceId": { + "type": "string", + "description": "Fully qualified resource id of source Endpoint. This id may no longer exist.", + "readOnly": true + }, + "sourceProperties": { + "type": "object", + "description": "Copy of source Endpoint resource's properties at time of Job Run creation.", + "readOnly": true + }, + "targetName": { + "type": "string", + "description": "Name of target Endpoint resource. This resource may no longer exist.", + "readOnly": true + }, + "targetResourceId": { + "type": "string", + "description": "Fully qualified resource id of of Endpoint. This id may no longer exist.", + "readOnly": true + }, + "targetProperties": { + "type": "object", + "description": "Copy of Endpoint resource's properties at time of Job Run creation.", + "readOnly": true + }, + "jobDefinitionProperties": { + "type": "object", + "description": "Copy of parent Job Definition's properties at time of Job Run creation.", + "readOnly": true + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/JobRunError", + "description": "Error details." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "enum": [ + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "JobRun": { + "description": "The Job Run resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JobRunProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "JobRunResourceId": { + "description": "Response that identifies a Job Run.", + "type": "object", + "properties": { + "jobRunResourceId": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource id of the Job Run." + } + } + }, + "JobRunList": { + "description": "List of Job Runs.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobRun" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "description": "Project properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Project." + }, + "provisioningState": { + "description": "The provisioning state of this resource.", + "enum": [ + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "Project": { + "description": "The Project resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Resource system metadata." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ProjectUpdateProperties": { + "description": "Project properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for the Project." + } + } + }, + "ProjectUpdateParameters": { + "description": "The Project resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectUpdateProperties" + } + } + }, + "ProjectList": { + "description": "List of Project resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + } + } + }, + "parameters": { + "AgentNameParameter": { + "name": "agentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Agent resource.", + "x-ms-parameter-location": "method" + }, + "StorageMoverNameParameter": { + "name": "storageMoverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Storage Mover resource.", + "x-ms-parameter-location": "method" + }, + "EndpointNameParameter": { + "name": "endpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Endpoint resource.", + "x-ms-parameter-location": "method" + }, + "JobDefinitionNameParameter": { + "name": "jobDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Job Definition resource.", + "x-ms-parameter-location": "method" + }, + "JobRunNameParameter": { + "name": "jobRunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Job Run resource.", + "x-ms-parameter-location": "method" + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Project resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storagemover/resource-manager/readme.md b/specification/storagemover/resource-manager/readme.md index 6323ad669509..92a8cda26488 100644 --- a/specification/storagemover/resource-manager/readme.md +++ b/specification/storagemover/resource-manager/readme.md @@ -27,18 +27,27 @@ These are the global settings for the storagemover. ``` yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2023-03 +tag: package-preview-2023-07 ``` +### Tag: package-preview-2023-07 + +These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2023-07' +input-file: + - Microsoft.StorageMover/preview/2023-07-01-preview/storagemover.json +``` ### Tag: package-2023-03 These settings apply only when `--tag=package-2023-03` is specified on the command line. -```yaml $(tag) == 'package-2023-03' +``` yaml $(tag) == 'package-2023-03' input-file: - Microsoft.StorageMover/stable/2023-03-01/storagemover.json ``` + ### Tag: package-2022-07-01-preview These settings apply only when `--tag=package-2022-07-01-preview` is specified on the command line. diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/examples/RenameSqlPool.json deleted file mode 100644 index e1dae41e3ce8..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/examples/RenameSqlPool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "workspaceName": "testsvr", - "sqlPoolName": "testdb", - "api-version": "2021-04-01-preview", - "parameters": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/sqlPool.json index 168d541a900e..d1a36e297ea3 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/sqlPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-04-01-preview/sqlPool.json @@ -459,63 +459,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { - "post": { - "operationId": "SqlPools_Rename", - "summary": "Rename a SQL pool", - "description": "Rename a SQL pool.", - "tags": [ - "SqlPools" - ], - "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": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "type": "string", - "in": "path", - "name": "sqlPoolName", - "description": "SQL pool name", - "required": true - }, - { - "name": "parameters", - "in": "body", - "description": "The resource move definition for renaming this Sql pool.", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceMoveDefinition" - } - } - ], - "responses": { - "200": { - "description": "Successfully renamed the Sql pool" - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Rename a SQL Analytics pool": { - "$ref": "./examples/RenameSqlPool.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { "get": { "operationId": "SqlPoolMetadataSyncConfigs_Get", @@ -7010,19 +6953,6 @@ } } }, - "ResourceMoveDefinition": { - "description": "Contains the information necessary to perform a resource move (rename).", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The target ID for the resource", - "type": "string" - } - } - }, "CreateSqlPoolRestorePointDefinition": { "description": "Contains the information necessary to perform a create Sql pool restore point operation.", "required": [ diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/RenameSqlPool.json deleted file mode 100644 index b7519b0e531c..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/RenameSqlPool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "workspaceName": "testsvr", - "sqlPoolName": "testdb", - "api-version": "2021-06-01-preview", - "parameters": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json index 62624676e6f1..b0e640901a93 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlPool.json @@ -467,63 +467,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { - "post": { - "operationId": "SqlPools_Rename", - "summary": "Rename a SQL pool", - "description": "Rename a SQL pool.", - "tags": [ - "SqlPools" - ], - "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": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" - }, - { - "type": "string", - "in": "path", - "name": "sqlPoolName", - "description": "SQL pool name", - "required": true - }, - { - "name": "parameters", - "in": "body", - "description": "The resource move definition for renaming this Sql pool.", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceMoveDefinition" - } - } - ], - "responses": { - "200": { - "description": "Successfully renamed the Sql pool" - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Rename a SQL Analytics pool": { - "$ref": "./examples/RenameSqlPool.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { "get": { "operationId": "SqlPoolMetadataSyncConfigs_Get", @@ -7209,19 +7152,6 @@ } } }, - "ResourceMoveDefinition": { - "description": "Contains the information necessary to perform a resource move (rename).", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The target ID for the resource", - "type": "string" - } - } - }, "CreateSqlPoolRestorePointDefinition": { "description": "Contains the information necessary to perform a create Sql pool restore point operation.", "required": [ diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/RenameSqlPool.json deleted file mode 100644 index 2768b040293c..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/examples/RenameSqlPool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "workspaceName": "testsvr", - "sqlPoolName": "testdb", - "api-version": "2020-12-01", - "parameters": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlPool.json index 194fbfdeb7dd..990ddb87d16f 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlPool.json @@ -459,63 +459,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { - "post": { - "operationId": "SqlPools_Rename", - "summary": "Rename a SQL pool", - "description": "Rename a SQL pool.", - "tags": [ - "SqlPools" - ], - "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": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "type": "string", - "in": "path", - "name": "sqlPoolName", - "description": "SQL pool name", - "required": true - }, - { - "name": "parameters", - "in": "body", - "description": "The resource move definition for renaming this Sql pool.", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceMoveDefinition" - } - } - ], - "responses": { - "200": { - "description": "Successfully renamed the Sql pool" - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Rename a SQL Analytics pool": { - "$ref": "./examples/RenameSqlPool.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { "get": { "operationId": "SqlPoolMetadataSyncConfigs_Get", @@ -7006,19 +6949,6 @@ } } }, - "ResourceMoveDefinition": { - "description": "Contains the information necessary to perform a resource move (rename).", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The target ID for the resource", - "type": "string" - } - } - }, "CreateSqlPoolRestorePointDefinition": { "description": "Contains the information necessary to perform a create Sql pool restore point operation.", "required": [ diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/examples/RenameSqlPool.json deleted file mode 100644 index 1b5bd10ceab8..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/examples/RenameSqlPool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "workspaceName": "testsvr", - "sqlPoolName": "testdb", - "api-version": "2021-03-01", - "parameters": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/sqlPool.json index 50d955f008ae..5865e74fc882 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/sqlPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-03-01/sqlPool.json @@ -459,63 +459,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { - "post": { - "operationId": "SqlPools_Rename", - "summary": "Rename a SQL pool", - "description": "Rename a SQL pool.", - "tags": [ - "SqlPools" - ], - "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": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "type": "string", - "in": "path", - "name": "sqlPoolName", - "description": "SQL pool name", - "required": true - }, - { - "name": "parameters", - "in": "body", - "description": "The resource move definition for renaming this Sql pool.", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceMoveDefinition" - } - } - ], - "responses": { - "200": { - "description": "Successfully renamed the Sql pool" - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Rename a SQL Analytics pool": { - "$ref": "./examples/RenameSqlPool.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { "get": { "operationId": "SqlPoolMetadataSyncConfigs_Get", @@ -7009,19 +6952,6 @@ } } }, - "ResourceMoveDefinition": { - "description": "Contains the information necessary to perform a resource move (rename).", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The target ID for the resource", - "type": "string" - } - } - }, "CreateSqlPoolRestorePointDefinition": { "description": "Contains the information necessary to perform a create Sql pool restore point operation.", "required": [ diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RenameSqlPool.json deleted file mode 100644 index 5e5bd131cd20..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/examples/RenameSqlPool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "workspaceName": "testsvr", - "sqlPoolName": "testdb", - "api-version": "2021-05-01", - "parameters": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json index c9a6d2349ce8..133b991eb51a 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-05-01/sqlPool.json @@ -459,63 +459,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { - "post": { - "operationId": "SqlPools_Rename", - "summary": "Rename a SQL pool", - "description": "Rename a SQL pool.", - "tags": [ - "SqlPools" - ], - "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": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "type": "string", - "in": "path", - "name": "sqlPoolName", - "description": "SQL pool name", - "required": true - }, - { - "name": "parameters", - "in": "body", - "description": "The resource move definition for renaming this Sql pool.", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceMoveDefinition" - } - } - ], - "responses": { - "200": { - "description": "Successfully renamed the Sql pool" - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Rename a SQL Analytics pool": { - "$ref": "./examples/RenameSqlPool.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { "get": { "operationId": "SqlPoolMetadataSyncConfigs_Get", @@ -7009,19 +6952,6 @@ } } }, - "ResourceMoveDefinition": { - "description": "Contains the information necessary to perform a resource move (rename).", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The target ID for the resource", - "type": "string" - } - } - }, "CreateSqlPoolRestorePointDefinition": { "description": "Contains the information necessary to perform a create Sql pool restore point operation.", "required": [ diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RenameSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RenameSqlPool.json deleted file mode 100644 index 56b14cd3222d..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/RenameSqlPool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "workspaceName": "testsvr", - "sqlPoolName": "testdb", - "api-version": "2021-06-01", - "parameters": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Synapse/workspaces/testsvr/sqlPools/newtestdb" - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/sqlPool.json index fac49e9463cb..61512fc37b56 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/sqlPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/sqlPool.json @@ -467,63 +467,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/move": { - "post": { - "operationId": "SqlPools_Rename", - "summary": "Rename a SQL pool", - "description": "Rename a SQL pool.", - "tags": [ - "SqlPools" - ], - "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": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" - }, - { - "type": "string", - "in": "path", - "name": "sqlPoolName", - "description": "SQL pool name", - "required": true - }, - { - "name": "parameters", - "in": "body", - "description": "The resource move definition for renaming this Sql pool.", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceMoveDefinition" - } - } - ], - "responses": { - "200": { - "description": "Successfully renamed the Sql pool" - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Rename a SQL Analytics pool": { - "$ref": "./examples/RenameSqlPool.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/metadataSync/config": { "get": { "operationId": "SqlPoolMetadataSyncConfigs_Get", @@ -7131,19 +7074,6 @@ } } }, - "ResourceMoveDefinition": { - "description": "Contains the information necessary to perform a resource move (rename).", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "The target ID for the resource", - "type": "string" - } - } - }, "CreateSqlPoolRestorePointDefinition": { "description": "Contains the information necessary to perform a create Sql pool restore point operation.", "required": [ diff --git a/specification/translation/Azure.AI.TextTranslation/routes.tsp b/specification/translation/Azure.AI.TextTranslation/routes.tsp index d7f5b599a8b4..850261f2d4a7 100644 --- a/specification/translation/Azure.AI.TextTranslation/routes.tsp +++ b/specification/translation/Azure.AI.TextTranslation/routes.tsp @@ -29,7 +29,7 @@ op CustomOperation< @doc("Mandatory API version parameter") @query("api-version") - apiVersion: string + apiVersion: string, ): TResponse | TError; @doc("Defines Text Translation custom Operations which doesn't have any content in the request") @@ -38,7 +38,7 @@ op CustomGetOperation( @doc("Mandatory API version parameter") @query("api-version") - apiVersion: string + apiVersion: string, ): TResponse | TError; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is an existing service, we have a non-conforming operation." diff --git a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json index bd7d6ff95748..8aa0404fcb70 100644 --- a/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json +++ b/specification/translation/data-plane/Azure.AI.TextTranslation/stable/v3.0/openapi.json @@ -45,10 +45,10 @@ { "name": "X-ClientTraceId", "in": "header", - "required": false, "description": "A client-generated GUID to uniquely identify the request.", - "x-ms-client-name": "clientTraceId", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "clientTraceId" }, { "$ref": "#/parameters/BreakSentenceParameters.language" @@ -59,54 +59,52 @@ { "name": "api-version", "in": "query", - "required": true, "description": "Mandatory API version parameter", - "x-ms-client-name": "apiVersion", - "type": "string" + "required": true, + "type": "string", + "x-ms-client-name": "apiVersion" }, { "name": "requestBody", "in": "body", - "required": true, "description": "Defines the content of the request", + "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/InputTextItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "InputTextItem[]" + "x-ms-identifiers": [] } } ], "responses": { "200": { "description": "Response for the Break SEntence API.", - "headers": { - "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" - } - }, "schema": { "type": "array", "items": { "$ref": "#/definitions/BreakSentenceItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "BreakSentenceItem[]" + "x-ms-identifiers": [] + }, + "headers": { + "X-RequestId": { + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." } - }, - "schema": { - "$ref": "#/definitions/ErrorResponse" } } }, @@ -129,76 +127,74 @@ { "name": "X-ClientTraceId", "in": "header", - "required": false, "description": "A client-generated GUID to uniquely identify the request.", - "x-ms-client-name": "clientTraceId", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "clientTraceId" }, { "name": "from", "in": "query", - "required": true, "description": "Specifies the language of the input text.\nThe source language must be one of the supported languages included in the dictionary scope.", + "required": true, "type": "string" }, { "name": "to", "in": "query", - "required": true, "description": "Specifies the language of the output text.\nThe target language must be one of the supported languages included in the dictionary scope.", + "required": true, "type": "string" }, { "name": "api-version", "in": "query", - "required": true, "description": "Mandatory API version parameter", - "x-ms-client-name": "apiVersion", - "type": "string" + "required": true, + "type": "string", + "x-ms-client-name": "apiVersion" }, { "name": "requestBody", "in": "body", - "required": true, "description": "Defines the content of the request", + "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/DictionaryExampleTextItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "DictionaryExampleTextItem[]" + "x-ms-identifiers": [] } } ], "responses": { "200": { "description": "Response for the dictionary examples API.", - "headers": { - "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" - } - }, "schema": { "type": "array", "items": { "$ref": "#/definitions/DictionaryExampleItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "DictionaryExampleItem[]" + "x-ms-identifiers": [] + }, + "headers": { + "X-RequestId": { + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." } - }, - "schema": { - "$ref": "#/definitions/ErrorResponse" } } }, @@ -221,76 +217,74 @@ { "name": "X-ClientTraceId", "in": "header", - "required": false, "description": "A client-generated GUID to uniquely identify the request.", - "x-ms-client-name": "clientTraceId", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "clientTraceId" }, { "name": "from", "in": "query", - "required": true, "description": "Specifies the language of the input text.\nThe source language must be one of the supported languages included in the dictionary scope.", + "required": true, "type": "string" }, { "name": "to", "in": "query", - "required": true, "description": "Specifies the language of the output text.\nThe target language must be one of the supported languages included in the dictionary scope.", + "required": true, "type": "string" }, { "name": "api-version", "in": "query", - "required": true, "description": "Mandatory API version parameter", - "x-ms-client-name": "apiVersion", - "type": "string" + "required": true, + "type": "string", + "x-ms-client-name": "apiVersion" }, { "name": "requestBody", "in": "body", - "required": true, "description": "Defines the content of the request", + "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/InputTextItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "InputTextItem[]" + "x-ms-identifiers": [] } } ], "responses": { "200": { "description": "Response for the dictionary lookup API.", - "headers": { - "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" - } - }, "schema": { "type": "array", "items": { "$ref": "#/definitions/DictionaryLookupItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "DictionaryLookupItem[]" + "x-ms-identifiers": [] + }, + "headers": { + "X-RequestId": { + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." } - }, - "schema": { - "$ref": "#/definitions/ErrorResponse" } } }, @@ -313,10 +307,10 @@ { "name": "X-ClientTraceId", "in": "header", - "required": false, "description": "A client-generated GUID to uniquely identify the request.", - "x-ms-client-name": "clientTraceId", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "clientTraceId" }, { "$ref": "#/parameters/GetLanguageParameters.scope" @@ -330,39 +324,39 @@ { "name": "api-version", "in": "query", - "required": true, "description": "Mandatory API version parameter", - "x-ms-client-name": "apiVersion", - "type": "string" + "required": true, + "type": "string", + "x-ms-client-name": "apiVersion" } ], "responses": { "200": { "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/GetLanguagesResult" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." }, "ETag": { - "description": "Current value of the entity tag for the requested groups of supported languages. \nTo make subsequent requests more efficient, the client may send the `ETag` value in an \n`If-None-Match` header field.", - "type": "string" + "type": "string", + "description": "Current value of the entity tag for the requested groups of supported languages. \nTo make subsequent requests more efficient, the client may send the `ETag` value in an \n`If-None-Match` header field." } - }, - "schema": { - "$ref": "#/definitions/GetLanguagesResult" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." } - }, - "schema": { - "$ref": "#/definitions/ErrorResponse" } } }, @@ -385,10 +379,10 @@ { "name": "X-ClientTraceId", "in": "header", - "required": false, "description": "A client-generated GUID to uniquely identify the request.", - "x-ms-client-name": "clientTraceId", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "clientTraceId" }, { "$ref": "#/parameters/TranslateParameters.to" @@ -429,33 +423,39 @@ { "name": "api-version", "in": "query", - "required": true, "description": "Mandatory API version parameter", - "x-ms-client-name": "apiVersion", - "type": "string" + "required": true, + "type": "string", + "x-ms-client-name": "apiVersion" }, { "name": "requestBody", "in": "body", - "required": true, "description": "Defines the content of the request", + "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/InputTextItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "InputTextItem[]" + "x-ms-identifiers": [] } } ], "responses": { "200": { "description": "Response for the translation API.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TranslatedTextItem" + }, + "x-ms-identifiers": [] + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." }, "x-mt-system": { "description": "Specifies the system type that was used for translation for each 'to' language requested for translation. \nThe value is a comma-separated list of strings. Each string indicates a type:\n\n* Custom - Request includes a custom system and at least one custom system was used during translation.\n* Team - All other requests", @@ -466,26 +466,18 @@ "type": "integer", "format": "int32" } - }, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/TranslatedTextItem" - }, - "x-ms-identifiers": [], - "x-typespec-name": "TranslatedTextItem[]" } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." } - }, - "schema": { - "$ref": "#/definitions/ErrorResponse" } } }, @@ -508,10 +500,10 @@ { "name": "X-ClientTraceId", "in": "header", - "required": false, "description": "A client-generated GUID to uniquely identify the request.", - "x-ms-client-name": "clientTraceId", - "type": "string" + "required": false, + "type": "string", + "x-ms-client-name": "clientTraceId" }, { "$ref": "#/parameters/TransliterateParameters.language" @@ -525,54 +517,52 @@ { "name": "api-version", "in": "query", - "required": true, "description": "Mandatory API version parameter", - "x-ms-client-name": "apiVersion", - "type": "string" + "required": true, + "type": "string", + "x-ms-client-name": "apiVersion" }, { "name": "requestBody", "in": "body", - "required": true, "description": "Defines the content of the request", + "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/InputTextItem" }, - "x-ms-identifiers": [], - "x-typespec-name": "InputTextItem[]" + "x-ms-identifiers": [] } } ], "responses": { "200": { "description": "Response for the transliteration API.", - "headers": { - "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" - } - }, "schema": { "type": "array", "items": { "$ref": "#/definitions/TransliteratedText" }, - "x-ms-identifiers": [], - "x-typespec-name": "TransliteratedText[]" + "x-ms-identifiers": [] + }, + "headers": { + "X-RequestId": { + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." + } } }, "default": { "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, "headers": { "X-RequestId": { - "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes.", - "type": "string" + "type": "string", + "description": "Value generated by the service to identify the request. It is used for troubleshooting purposes." } - }, - "schema": { - "$ref": "#/definitions/ErrorResponse" } } }, @@ -607,6 +597,7 @@ }, "BackTranslation": { "type": "object", + "description": "Back Translation", "properties": { "normalizedText": { "type": "string", @@ -627,7 +618,6 @@ "description": "An integer representing the frequency of this translation pair in the data. The main purpose of this\nfield is to provide a user interface with a means to sort back-translations so the most frequent terms are first." } }, - "description": "Back Translation", "required": [ "normalizedText", "displayText", @@ -637,6 +627,7 @@ }, "BreakSentenceItem": { "type": "object", + "description": "Item containing break sentence result.", "properties": { "detectedLanguage": { "$ref": "#/definitions/DetectedLanguage", @@ -644,39 +635,37 @@ }, "sentLen": { "type": "array", + "description": "An integer array representing the lengths of the sentences in the input text.\nThe length of the array is the number of sentences, and the values are the length of each sentence.", "items": { "type": "integer", "format": "int32" - }, - "description": "An integer array representing the lengths of the sentences in the input text.\nThe length of the array is the number of sentences, and the values are the length of each sentence.", - "x-typespec-name": "int32[]" + } } }, - "description": "Item containing break sentence result.", "required": [ "sentLen" ] }, "BreakSentenceResult": { "type": "object", + "description": "Response for the Break SEntence API.", "properties": { "result": { "type": "array", + "description": "Array of the break sentence elements.", "items": { "$ref": "#/definitions/BreakSentenceItem" }, - "x-ms-identifiers": [], - "description": "Array of the break sentence elements.", - "x-typespec-name": "BreakSentenceItem[]" + "x-ms-identifiers": [] } }, - "description": "Response for the Break SEntence API.", "required": [ "result" ] }, "CommonScriptModel": { "type": "object", + "description": "Common properties of language script", "properties": { "code": { "type": "string", @@ -695,7 +684,6 @@ "description": "Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages." } }, - "description": "Common properties of language script", "required": [ "code", "name", @@ -705,6 +693,7 @@ }, "DetectedLanguage": { "type": "object", + "description": "An object describing the detected language.", "properties": { "language": { "type": "string", @@ -716,7 +705,6 @@ "description": "A float value indicating the confidence in the result.\nThe score is between zero and one and a low score indicates a low confidence." } }, - "description": "An object describing the detected language.", "required": [ "language", "score" @@ -724,6 +712,7 @@ }, "DictionaryExample": { "type": "object", + "description": "Dictionary Example", "properties": { "sourcePrefix": { "type": "string", @@ -750,7 +739,6 @@ "description": "A string similar to sourceSuffix but for the target." } }, - "description": "Dictionary Example", "required": [ "sourcePrefix", "sourceTerm", @@ -762,6 +750,7 @@ }, "DictionaryExampleItem": { "type": "object", + "description": "Dictionary Example element", "properties": { "normalizedSource": { "type": "string", @@ -773,15 +762,13 @@ }, "examples": { "type": "array", + "description": "A list of examples for the (source term, target term) pair.", "items": { "$ref": "#/definitions/DictionaryExample" }, - "x-ms-identifiers": [], - "description": "A list of examples for the (source term, target term) pair.", - "x-typespec-name": "DictionaryExample[]" + "x-ms-identifiers": [] } }, - "description": "Dictionary Example element", "required": [ "normalizedSource", "normalizedTarget", @@ -790,13 +777,13 @@ }, "DictionaryExampleTextItem": { "type": "object", + "description": "Element containing the text with translation.", "properties": { "translation": { "type": "string", "description": "A string specifying the translated text previously returned by the Dictionary lookup operation. \nThis should be the value from the normalizedTarget field in the translations list of the Dictionary \nlookup response. The service will return examples for the specific source-target word-pair." } }, - "description": "Element containing the text with translation.", "required": [ "translation" ], @@ -808,6 +795,7 @@ }, "DictionaryExamplesParameters": { "type": "object", + "description": "Request parameters for the dictionary examples API.", "properties": { "from": { "type": "string", @@ -818,7 +806,6 @@ "description": "Specifies the language of the output text.\nThe target language must be one of the supported languages included in the dictionary scope." } }, - "description": "Request parameters for the dictionary examples API.", "required": [ "from", "to" @@ -826,24 +813,24 @@ }, "DictionaryExamplesResult": { "type": "object", + "description": "Response for the dictionary examples API.", "properties": { "result": { "type": "array", + "description": "Array of the dictionary examples elements.", "items": { "$ref": "#/definitions/DictionaryExampleItem" }, - "x-ms-identifiers": [], - "description": "Array of the dictionary examples elements.", - "x-typespec-name": "DictionaryExampleItem[]" + "x-ms-identifiers": [] } }, - "description": "Response for the dictionary examples API.", "required": [ "result" ] }, "DictionaryLookupItem": { "type": "object", + "description": "Dictionary Lookup Element", "properties": { "normalizedSource": { "type": "string", @@ -855,15 +842,13 @@ }, "translations": { "type": "array", + "description": "A list of translations for the source term.", "items": { "$ref": "#/definitions/DictionaryTranslation" }, - "x-ms-identifiers": [], - "description": "A list of translations for the source term.", - "x-typespec-name": "DictionaryTranslation[]" + "x-ms-identifiers": [] } }, - "description": "Dictionary Lookup Element", "required": [ "normalizedSource", "displaySource", @@ -872,6 +857,7 @@ }, "DictionaryLookupParameters": { "type": "object", + "description": "Request parameters for the dictionary lookup API.", "properties": { "from": { "type": "string", @@ -882,7 +868,6 @@ "description": "Specifies the language of the output text.\nThe target language must be one of the supported languages included in the dictionary scope." } }, - "description": "Request parameters for the dictionary lookup API.", "required": [ "from", "to" @@ -890,24 +875,24 @@ }, "DictionaryLookupResult": { "type": "object", + "description": "Response for the dictionary lookup API.", "properties": { "result": { "type": "array", + "description": "Array of the dictionary lookup elements.", "items": { "$ref": "#/definitions/DictionaryLookupItem" }, - "x-ms-identifiers": [], - "description": "Array of the dictionary lookup elements.", - "x-typespec-name": "DictionaryLookupItem[]" + "x-ms-identifiers": [] } }, - "description": "Response for the dictionary lookup API.", "required": [ "result" ] }, "DictionaryTranslation": { "type": "object", + "description": "Translation source term.", "properties": { "normalizedTarget": { "type": "string", @@ -932,15 +917,13 @@ }, "backTranslations": { "type": "array", + "description": "A list of \"back translations\" of the target. For example, source words that the target can translate to.\nThe list is guaranteed to contain the source word that was requested (e.g., if the source word being\nlooked up is \"fly\", then it is guaranteed that \"fly\" will be in the backTranslations list).\nHowever, it is not guaranteed to be in the first position, and often will not be.", "items": { "$ref": "#/definitions/BackTranslation" }, - "x-ms-identifiers": [], - "description": "A list of \"back translations\" of the target. For example, source words that the target can translate to.\nThe list is guaranteed to contain the source word that was requested (e.g., if the source word being\nlooked up is \"fly\", then it is guaranteed that \"fly\" will be in the backTranslations list).\nHowever, it is not guaranteed to be in the first position, and often will not be.", - "x-typespec-name": "BackTranslation[]" + "x-ms-identifiers": [] } }, - "description": "Translation source term.", "required": [ "normalizedTarget", "displayTarget", @@ -952,6 +935,7 @@ }, "ErrorDetails": { "type": "object", + "description": "Error details as returned by Translator Service.", "properties": { "code": { "type": "integer", @@ -963,7 +947,6 @@ "description": "Human readable error description." } }, - "description": "Error details as returned by Translator Service.", "required": [ "code", "message" @@ -971,56 +954,53 @@ }, "ErrorResponse": { "type": "object", + "description": "Representation of the Error Response from Translator Service.", "properties": { "error": { "$ref": "#/definitions/ErrorDetails", "description": "Error details." } }, - "description": "Representation of the Error Response from Translator Service.", "required": [ "error" ] }, "GetLanguagesResult": { "type": "object", + "description": "Response for the languages API.", "properties": { "translation": { "type": "object", + "description": "Languages that support translate API.", "additionalProperties": { "$ref": "#/definitions/TranslationLanguage" - }, - "description": "Languages that support translate API.", - "x-typespec-name": "Record" + } }, "transliteration": { "type": "object", + "description": "Languages that support transliteration API.", "additionalProperties": { "$ref": "#/definitions/TransliterationLanguage" - }, - "description": "Languages that support transliteration API.", - "x-typespec-name": "Record" + } }, "dictionary": { "type": "object", + "description": "Languages that support dictionary API.", "additionalProperties": { "$ref": "#/definitions/SourceDictionaryLanguage" - }, - "description": "Languages that support dictionary API.", - "x-typespec-name": "Record" + } } - }, - "description": "Response for the languages API." + } }, "InputTextItem": { "type": "object", + "description": "Element containing the text for translation.", "properties": { "text": { "type": "string", "description": "Text to translate." } }, - "description": "Element containing the text for translation.", "required": [ "text" ] @@ -1121,27 +1101,25 @@ }, "SentenceLength": { "type": "object", + "description": "An object returning sentence boundaries in the input and output texts.", "properties": { "srcSentLen": { "type": "array", + "description": "An integer array representing the lengths of the sentences in the input text. \nThe length of the array is the number of sentences, and the values are the length of each sentence.", "items": { "type": "integer", "format": "int32" - }, - "description": "An integer array representing the lengths of the sentences in the input text. \nThe length of the array is the number of sentences, and the values are the length of each sentence.", - "x-typespec-name": "int32[]" + } }, "transSentLen": { "type": "array", + "description": "An integer array representing the lengths of the sentences in the translated text. \nThe length of the array is the number of sentences, and the values are the length of each sentence.", "items": { "type": "integer", "format": "int32" - }, - "description": "An integer array representing the lengths of the sentences in the translated text. \nThe length of the array is the number of sentences, and the values are the length of each sentence.", - "x-typespec-name": "int32[]" + } } }, - "description": "An object returning sentence boundaries in the input and output texts.", "required": [ "srcSentLen", "transSentLen" @@ -1149,6 +1127,7 @@ }, "SourceDictionaryLanguage": { "type": "object", + "description": "Properties ot the source dictionary language", "properties": { "name": { "type": "string", @@ -1164,15 +1143,13 @@ }, "translations": { "type": "array", + "description": "List of languages with alterative translations and examples for the query expressed in the source language.", "items": { "$ref": "#/definitions/TargetDictionaryLanguage" }, - "x-ms-identifiers": [], - "description": "List of languages with alterative translations and examples for the query expressed in the source language.", - "x-typespec-name": "TargetDictionaryLanguage[]" + "x-ms-identifiers": [] } }, - "description": "Properties ot the source dictionary language", "required": [ "name", "nativeName", @@ -1182,19 +1159,20 @@ }, "SourceText": { "type": "object", + "description": "Input text in the default script of the source language. ", "properties": { "text": { "type": "string", "description": "Input text in the default script of the source language." } }, - "description": "Input text in the default script of the source language. ", "required": [ "text" ] }, "TargetDictionaryLanguage": { "type": "object", + "description": "Properties of the target dictionary language", "properties": { "name": { "type": "string", @@ -1213,7 +1191,6 @@ "description": "Language code identifying the target language." } }, - "description": "Properties of the target dictionary language", "required": [ "name", "nativeName", @@ -1265,19 +1242,20 @@ }, "TranslatedTextAlignment": { "type": "object", + "description": "Alignment information object.", "properties": { "proj": { "type": "string", "description": "Maps input text to translated text. The alignment information is only provided when the request \nparameter includeAlignment is true. Alignment is returned as a string value of the following \nformat: [[SourceTextStartIndex]:[SourceTextEndIndex]–[TgtTextStartIndex]:[TgtTextEndIndex]]. \nThe colon separates start and end index, the dash separates the languages, and space separates the words. \nOne word may align with zero, one, or multiple words in the other language, and the aligned words may \nbe non-contiguous. When no alignment information is available, the alignment element will be empty." } }, - "description": "Alignment information object.", "required": [ "proj" ] }, "TranslatedTextItem": { "type": "object", + "description": "Element containing the translated text", "properties": { "detectedLanguage": { "$ref": "#/definitions/DetectedLanguage", @@ -1285,25 +1263,24 @@ }, "translations": { "type": "array", + "description": "An array of translation results. The size of the array matches the number of target \nlanguages specified through the to query parameter.", "items": { "$ref": "#/definitions/Translation" }, - "x-ms-identifiers": [], - "description": "An array of translation results. The size of the array matches the number of target \nlanguages specified through the to query parameter.", - "x-typespec-name": "Translation[]" + "x-ms-identifiers": [] }, "sourceText": { "$ref": "#/definitions/SourceText", "description": "Input text in the default script of the source language. sourceText property is present only when \nthe input is expressed in a script that's not the usual script for the language. For example, \nif the input were Arabic written in Latin script, then sourceText.text would be the same Arabic text \nconverted into Arab script." } }, - "description": "Element containing the translated text", "required": [ "translations" ] }, "Translation": { "type": "object", + "description": "Translation result", "properties": { "to": { "type": "string", @@ -1326,7 +1303,6 @@ "description": "Sentence boundaries in the input and output texts." } }, - "description": "Translation result", "required": [ "to", "text" @@ -1334,6 +1310,7 @@ }, "TranslationLanguage": { "type": "object", + "description": "The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag.\nA key identifies a language for which text can be translated to or translated from.", "properties": { "name": { "type": "string", @@ -1348,7 +1325,6 @@ "description": "Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages." } }, - "description": "The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag.\nA key identifies a language for which text can be translated to or translated from.", "required": [ "name", "nativeName", @@ -1357,36 +1333,34 @@ }, "TranslationResult": { "type": "object", + "description": "Response for the translation API.", "properties": { "result": { "type": "array", + "description": "Array of the translated text elements.", "items": { "$ref": "#/definitions/TranslatedTextItem" }, - "x-ms-identifiers": [], - "description": "Array of the translated text elements.", - "x-typespec-name": "TranslatedTextItem[]" + "x-ms-identifiers": [] } }, - "description": "Response for the translation API.", "required": [ "result" ] }, "TransliterableScript": { "type": "object", + "description": "Script definition with list of script into which given script can be translitered.", "properties": { "toScripts": { "type": "array", + "description": "List of scripts available to convert text to.", "items": { "$ref": "#/definitions/CommonScriptModel" }, - "x-ms-identifiers": [], - "description": "List of scripts available to convert text to.", - "x-typespec-name": "CommonScriptModel[]" + "x-ms-identifiers": [] } }, - "description": "Script definition with list of script into which given script can be translitered.", "required": [ "toScripts" ], @@ -1398,24 +1372,24 @@ }, "TransliterateResult": { "type": "object", + "description": "Response for the transliteration API.", "properties": { "result": { "type": "array", + "description": "Array of transliterated texts", "items": { "$ref": "#/definitions/TransliteratedText" }, - "x-ms-identifiers": [], - "description": "Array of transliterated texts", - "x-typespec-name": "TransliteratedText[]" + "x-ms-identifiers": [] } }, - "description": "Response for the transliteration API.", "required": [ "result" ] }, "TransliteratedText": { "type": "object", + "description": "Transliterated text element.", "properties": { "text": { "type": "string", @@ -1426,7 +1400,6 @@ "description": "A string specifying the script used in the output." } }, - "description": "Transliterated text element.", "required": [ "text", "script" @@ -1434,6 +1407,7 @@ }, "TransliterationLanguage": { "type": "object", + "description": "The value of the transliteration property is a dictionary of (key, value) pairs. \nEach key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script \nto another script.", "properties": { "name": { "type": "string", @@ -1445,15 +1419,13 @@ }, "scripts": { "type": "array", + "description": "List of scripts to convert from.", "items": { "$ref": "#/definitions/TransliterableScript" }, - "x-ms-identifiers": [], - "description": "List of scripts to convert from.", - "x-typespec-name": "TransliterableScript[]" + "x-ms-identifiers": [] } }, - "description": "The value of the transliteration property is a dictionary of (key, value) pairs. \nEach key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script \nto another script.", "required": [ "name", "nativeName", @@ -1465,105 +1437,105 @@ "BreakSentenceParameters.language": { "name": "language", "in": "query", - "required": false, "description": "Language tag identifying the language of the input text. \nIf a code isn't specified, automatic language detection will be applied.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "BreakSentenceParameters.script": { "name": "script", "in": "query", - "required": false, "description": "Script tag identifying the script used by the input text. \nIf a script isn't specified, the default script of the language will be assumed.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "GetLanguageParameters.acceptLanguage": { "name": "Accept-Language", "in": "header", - "required": false, "description": "The language to use for user interface strings. Some of the fields in the response are names of languages or \nnames of regions. Use this parameter to define the language in which these names are returned. \nThe language is specified by providing a well-formed BCP 47 language tag. For instance, use the value `fr` \nto request names in French or use the value `zh-Hant` to request names in Chinese Traditional.\nNames are provided in the English language when a target language is not specified or when localization \nis not available.", - "x-ms-client-name": "acceptLanguage", - "default": "en", + "required": false, "type": "string", - "x-ms-parameter-location": "method" + "default": "en", + "x-ms-parameter-location": "method", + "x-ms-client-name": "acceptLanguage" }, "GetLanguageParameters.ifNoneMatch": { "name": "If-None-Match", "in": "header", - "required": false, "description": "Passing the value of the ETag response header in an If-None-Match field will allow the service to optimize the response. \nIf the resource has not been modified, the service will return status code 304 and an empty response body.", - "x-ms-client-name": "ifNoneMatch", + "required": false, "type": "string", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-client-name": "ifNoneMatch" }, "GetLanguageParameters.scope": { "name": "scope", "in": "query", - "required": false, "description": "A comma-separated list of names defining the group of languages to return.\nAllowed group names are: `translation`, `transliteration` and `dictionary`.\nIf no scope is given, then all groups are returned, which is equivalent to passing \n`scope=translation,transliteration,dictionary`. To decide which set of supported languages \nis appropriate for your scenario, see the description of the [response object](#response-body).", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "TranslateParameters.allowFallback": { "name": "allowFallback", "in": "query", - "required": false, "description": "Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. \nPossible values are: true (default) or false.\n\nallowFallback=false specifies that the translation should only use systems trained for the category specified \nby the request. If a translation for language X to language Y requires chaining through a pivot language E, \nthen all the systems in the chain (X → E and E → Y) will need to be custom and have the same category. \nIf no system is found with the specific category, the request will return a 400 status code. allowFallback=true \nspecifies that the service is allowed to fall back to a general system when a custom system doesn't exist.", - "default": true, + "required": false, "type": "boolean", + "default": true, "x-ms-parameter-location": "method" }, "TranslateParameters.category": { "name": "category", "in": "query", - "required": false, "description": "A string specifying the category (domain) of the translation. This parameter is used to get translations \nfrom a customized system built with Custom Translator. Add the Category ID from your Custom Translator \nproject details to this parameter to use your deployed customized system. Default value is: general.", - "default": "general", + "required": false, "type": "string", + "default": "general", "x-ms-parameter-location": "method" }, "TranslateParameters.from": { "name": "from", "in": "query", - "required": false, "description": "Specifies the language of the input text. Find which languages are available to translate from by \nlooking up supported languages using the translation scope. If the from parameter isn't specified, \nautomatic language detection is applied to determine the source language.\n\nYou must use the from parameter rather than autodetection when using the dynamic dictionary feature. \nNote: the dynamic dictionary feature is case-sensitive.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "TranslateParameters.fromScript": { "name": "fromScript", "in": "query", - "required": false, "description": "Specifies the script of the input text.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "TranslateParameters.includeAlignment": { "name": "includeAlignment", "in": "query", - "required": false, "description": "Specifies whether to include alignment projection from source text to translated text.\nPossible values are: true or false (default).", - "default": false, + "required": false, "type": "boolean", + "default": false, "x-ms-parameter-location": "method" }, "TranslateParameters.includeSentenceLength": { "name": "includeSentenceLength", "in": "query", - "required": false, "description": "Specifies whether to include sentence boundaries for the input text and the translated text.\nPossible values are: true or false (default).", - "default": false, + "required": false, "type": "boolean", + "default": false, "x-ms-parameter-location": "method" }, "TranslateParameters.profanityAction": { "name": "profanityAction", "in": "query", - "required": false, "description": "Specifies how profanities should be treated in translations.\nPossible values are: NoAction (default), Marked or Deleted.", - "default": "NoAction", + "required": false, "type": "string", + "default": "NoAction", "enum": [ "NoAction", "Marked", @@ -1592,10 +1564,10 @@ "TranslateParameters.profanityMarker": { "name": "profanityMarker", "in": "query", - "required": false, "description": "Specifies how profanities should be marked in translations.\nPossible values are: Asterisk (default) or Tag. ", - "default": "Asterisk", + "required": false, "type": "string", + "default": "Asterisk", "enum": [ "Asterisk", "Tag" @@ -1619,18 +1591,18 @@ "TranslateParameters.suggestedFrom": { "name": "suggestedFrom", "in": "query", - "required": false, "description": "Specifies a fallback language if the language of the input text can't be identified. \nLanguage autodetection is applied when the from parameter is omitted. If detection fails, \nthe suggestedFrom language will be assumed.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "TranslateParameters.textType": { "name": "textType", "in": "query", - "required": false, "description": "Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a well-formed, \ncomplete element. Possible values are: plain (default) or html.", - "default": "Plain", + "required": false, "type": "string", + "default": "Plain", "enum": [ "Plain", "Html" @@ -1654,44 +1626,44 @@ "TranslateParameters.to": { "name": "to", "in": "query", - "required": true, "description": "Specifies the language of the output text. The target language must be one of the supported languages included \nin the translation scope. For example, use to=de to translate to German.\nIt's possible to translate to multiple languages simultaneously by repeating the parameter in the query string. \nFor example, use to=de&to=it to translate to German and Italian.", - "collectionFormat": "multi", + "required": true, "type": "array", "items": { "type": "string" }, + "collectionFormat": "multi", "x-ms-parameter-location": "method" }, "TranslateParameters.toScript": { "name": "toScript", "in": "query", - "required": false, "description": "Specifies the script of the translated text.", + "required": false, "type": "string", "x-ms-parameter-location": "method" }, "TransliterateParameters.fromScript": { "name": "fromScript", "in": "query", - "required": true, "description": "Specifies the script used by the input text. Look up supported languages using the transliteration scope,\nto find input scripts available for the selected language.", + "required": true, "type": "string", "x-ms-parameter-location": "method" }, "TransliterateParameters.language": { "name": "language", "in": "query", - "required": true, "description": "Specifies the language of the text to convert from one script to another. \nPossible languages are listed in the transliteration scope obtained by querying the service \nfor its supported languages.", + "required": true, "type": "string", "x-ms-parameter-location": "method" }, "TransliterateParameters.toScript": { "name": "toScript", "in": "query", - "required": true, "description": "Specifies the output script. Look up supported languages using the transliteration scope, to find output \nscripts available for the selected combination of input language and input script.", + "required": true, "type": "string", "x-ms-parameter-location": "method" }