From ae6e92d62421bfafa2b695d742f3820d5de204eb Mon Sep 17 00:00:00 2001 From: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Date: Tue, 21 Jan 2025 12:59:20 +0800 Subject: [PATCH 01/74] java mgmt, servicenetworking config (#32240) * java config * service name * format --- .../ServiceNetworking.Management/client.tsp | 8 ++++++++ .../ServiceNetworking.Management/tspconfig.yaml | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/specification/servicenetworking/ServiceNetworking.Management/client.tsp b/specification/servicenetworking/ServiceNetworking.Management/client.tsp index d56d22fffbb5..668473769c38 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/client.tsp +++ b/specification/servicenetworking/ServiceNetworking.Management/client.tsp @@ -8,3 +8,11 @@ using Azure.ClientGenerator.Core; "ServiceNetworkingManagementClient", "javascript" ); +@@clientName(Microsoft.ServiceNetworking, + "TrafficControllerManagementClient", + "java" +); +@@clientNamespace(Microsoft.ServiceNetworking, + "com.azure.resourcemanager.servicenetworking", + "java" +); diff --git a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml index 881b2e497e91..35d5cb72156e 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml +++ b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml @@ -35,3 +35,7 @@ options: flavor: "azure" generate-test: true generate-sample: true + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-servicenetworking" + flavor: "azure" + service-name: "Traffic Controller" From 100bee585713d12967d24987fabbb895f5c295f9 Mon Sep 17 00:00:00 2001 From: Daniel Jurek Date: Tue, 21 Jan 2025 08:45:55 -0800 Subject: [PATCH 02/74] Exclude scanning specificatin/suppressions.yaml which is mostly composed of filenames (#32250) --- cspell.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/cspell.yaml b/cspell.yaml index 97ec0b0d871b..37c1b46e2bde 100644 --- a/cspell.yaml +++ b/cspell.yaml @@ -11,6 +11,7 @@ ignorePaths: - cspell.yaml - eng/** - node_modules/** + - specification/suppressions.yaml ignoreRegExpList: - Base64 - email From 497d8eccdd76d904c7c137c77423c99836530bbc Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Tue, 21 Jan 2025 08:56:03 -0800 Subject: [PATCH 03/74] Sync eng/common directory with azure-sdk-tools for PR 9652 (#32239) * Update github.io docs to use static website instead of blobs directly * Update eng/common/scripts/copy-docs-to-blobstorage.ps1 Co-authored-by: Ben Broderick Phillips * Switch from AzurePowerShell to AzureCLI task * Add scriptLocation to docindex.yml * Update Generate-DocIndex.ps1 * Fix indentation in docindex.yml script block --------- Co-authored-by: Wes Haggard Co-authored-by: Wes Haggard Co-authored-by: Ben Broderick Phillips --- eng/common/docgeneration/Generate-DocIndex.ps1 | 3 ++- .../docgeneration/templates/matthews/styles/main.js | 10 +++++----- eng/common/pipelines/templates/jobs/docindex.yml | 10 ++++++---- eng/common/scripts/copy-docs-to-blobstorage.ps1 | 2 +- 4 files changed, 14 insertions(+), 11 deletions(-) diff --git a/eng/common/docgeneration/Generate-DocIndex.ps1 b/eng/common/docgeneration/Generate-DocIndex.ps1 index 2b8d59468bab..a279a2934511 100644 --- a/eng/common/docgeneration/Generate-DocIndex.ps1 +++ b/eng/common/docgeneration/Generate-DocIndex.ps1 @@ -25,13 +25,14 @@ function Get-BlobStorage-Artifacts( # "--query '[].name'" returns a list of only blob names # "--num-results *" handles pagination so the caller does not have to $artifacts = az storage blob list ` + --auth-mode login ` --account-name $storageAccountName ` --container-name $storageContainerName ` --prefix $storagePrefix ` --delimiter / ` --only-show-errors ` --query '[].name' ` - --num-results * | ConvertFrom-Json + --num-results * | ConvertFrom-Json LogDebug "Number of artifacts found: $($artifacts.Length)" # example: "python/azure-storage-blob" -> "azure-storage-blob" diff --git a/eng/common/docgeneration/templates/matthews/styles/main.js b/eng/common/docgeneration/templates/matthews/styles/main.js index 7ab1dd9e28ff..2bda06d0c2e1 100644 --- a/eng/common/docgeneration/templates/matthews/styles/main.js +++ b/eng/common/docgeneration/templates/matthews/styles/main.js @@ -108,7 +108,7 @@ function httpGetAsyncFallbackOnFail(targetUrl, successCallback, failureCallback) } function populateOptions(selector, packageName) { - var versionRequestUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" + var versionRequestUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" httpGetAsync(versionRequestUrl, function (responseText) { var versionselector = document.createElement("select") @@ -181,9 +181,9 @@ function loadedOtherVersions(url, latestVersions, publishedVersions, selector, c } function populateIndexList(selector, packageName) { - var url = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" - var latestGAUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-ga" - var latestPreviewUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-preview" + var url = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" + var latestGAUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-ga" + var latestPreviewUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-preview" var latestVersions = document.createElement("ul") httpGetLatestAsync(latestGAUrl, latestVersions, packageName) httpGetLatestAsync(latestPreviewUrl, latestVersions, packageName) @@ -217,7 +217,7 @@ function populateIndexList(selector, packageName) { } function getPackageUrl(language, package, version) { - return "https://azuresdkdocs.blob.core.windows.net/$web/" + language + "/" + package + "/" + version + "/index.html" + return "https://azuresdkdocs.z19.web.core.windows.net/" + language + "/" + package + "/" + version + "/index.html" } // Populate Versions diff --git a/eng/common/pipelines/templates/jobs/docindex.yml b/eng/common/pipelines/templates/jobs/docindex.yml index 8ba898e4c14d..45c19dc21000 100644 --- a/eng/common/pipelines/templates/jobs/docindex.yml +++ b/eng/common/pipelines/templates/jobs/docindex.yml @@ -15,12 +15,14 @@ jobs: workingDirectory: $(Build.BinariesDirectory) displayName: Download and Extract DocFX - - task: PowerShell@2 + - task: AzureCLI@2 displayName: 'Generate Doc Index' inputs: - pwsh: true - filePath: $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 - arguments: > + azureSubscription: 'Azure SDK Artifacts' + scriptType: pscore + scriptLocation: inlineScript + inlineScript: > + $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 -Docfx $(docfxPath) -RepoRoot $(Build.SourcesDirectory) -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration" diff --git a/eng/common/scripts/copy-docs-to-blobstorage.ps1 b/eng/common/scripts/copy-docs-to-blobstorage.ps1 index c4f88ce756f2..bfcae988b875 100644 --- a/eng/common/scripts/copy-docs-to-blobstorage.ps1 +++ b/eng/common/scripts/copy-docs-to-blobstorage.ps1 @@ -116,7 +116,7 @@ function Get-Existing-Versions Param ( [Parameter(Mandatory=$true)] [String]$PkgName ) - $versionUri = "${BlobAccountName}/`$web/$($Language)/$($PkgName)/versioning/versions" + $versionUri = "https://azuresdkdocs.z19.web.core.windows.net/$Language/$PkgName/versioning/versions" LogDebug "Heading to $versionUri to retrieve known versions" try { From a809dd5480dae39870b8094af9e6440591c90281 Mon Sep 17 00:00:00 2001 From: Nikhil Gupta <52026487+nikhgup@users.noreply.github.com> Date: Tue, 21 Jan 2025 23:42:55 +0530 Subject: [PATCH 04/74] Liftr Base typespec package upgrade (#32188) Co-authored-by: Mike Harder --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5cf5030378a5..4a47c7eae9e1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@azure-tools/typespec-azure-rulesets": "0.50.0", "@azure-tools/typespec-client-generator-cli": "0.15.1", "@azure-tools/typespec-client-generator-core": "0.50.0", - "@azure-tools/typespec-liftr-base": "0.6.0", + "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", "@typespec/compiler": "0.64.0", "@typespec/http": "0.64.0", @@ -1141,9 +1141,9 @@ } }, "node_modules/@azure-tools/typespec-liftr-base": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-liftr-base/-/typespec-liftr-base-0.6.0.tgz", - "integrity": "sha512-MQV7ESlCqWrgclTSgs/dllS/jKrMrjs9C0UNExXsYhpjUtpv/BnmToWaWL4hA/5rg5JgxDp1MSAjZ5PBjGo1ig==", + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-liftr-base/-/typespec-liftr-base-0.7.0.tgz", + "integrity": "sha512-r4pPk/nOVo6S651McQqLmuSNr7FIRLzt7pj2Pk0+H5EgniKm6X0uwsXk7u2N2GpEmoGnL2yVNxTTMSOtUrkXwQ==", "dev": true }, "node_modules/@azure-tools/typespec-requirement": { diff --git a/package.json b/package.json index abf6a4aca217..8a042d2251e6 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "@azure-tools/typespec-azure-rulesets": "0.50.0", "@azure-tools/typespec-client-generator-cli": "0.15.1", "@azure-tools/typespec-client-generator-core": "0.50.0", - "@azure-tools/typespec-liftr-base": "0.6.0", + "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", "@typespec/compiler": "0.64.0", "@typespec/http": "0.64.0", From 49da4e96668324bf65ee2ebb97a4615f41f4a7ea Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 21 Jan 2025 11:20:16 -0800 Subject: [PATCH 05/74] Bump @azure-tools/typespec-client-generator-cli (#32224) Bumps the typespec-client-generator-cli group with 1 update in the / directory: [@azure-tools/typespec-client-generator-cli](https://github.com/Azure/azure-sdk-tools). Updates `@azure-tools/typespec-client-generator-cli` from 0.15.1 to 0.15.3 - [Release notes](https://github.com/Azure/azure-sdk-tools/releases) - [Commits](https://github.com/Azure/azure-sdk-tools/commits) --- updated-dependencies: - dependency-name: "@azure-tools/typespec-client-generator-cli" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec-client-generator-cli ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 10 +++++----- package.json | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 4a47c7eae9e1..e6a772cb8b4e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,7 +12,7 @@ "@azure-tools/typespec-azure-portal-core": "0.50.0", "@azure-tools/typespec-azure-resource-manager": "0.50.0", "@azure-tools/typespec-azure-rulesets": "0.50.0", - "@azure-tools/typespec-client-generator-cli": "0.15.1", + "@azure-tools/typespec-client-generator-cli": "0.15.3", "@azure-tools/typespec-client-generator-core": "0.50.0", "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", @@ -1074,14 +1074,14 @@ } }, "node_modules/@azure-tools/typespec-client-generator-cli": { - "version": "0.15.1", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.15.1.tgz", - "integrity": "sha512-JoxYjI/LNZlWB7fAsfxBDo/BEpiiDHD/eKPvi8ex+9G+MVQLC4l9Ua0hp69EU/SS7FPcN9xDimuvyeNZjdR7lw==", + "version": "0.15.3", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.15.3.tgz", + "integrity": "sha512-sR7ZlsYL12TTRJS+O672NKQ9WEjP91nBl43wSCCuXVckf2UGSLRzR5AlN/fT8YjV6HlVcSEEDRjvD7z901Db7g==", "dev": true, "license": "MIT", "dependencies": { "@autorest/core": "^3.10.2", - "@autorest/openapi-to-typespec": "0.10.6", + "@autorest/openapi-to-typespec": ">=0.10.6 <1.0.0", "@azure-tools/rest-api-diff": ">=0.1.0 <1.0.0", "@azure-tools/typespec-autorest": ">=0.44.0 <1.0.0", "@azure/core-rest-pipeline": "^1.12.0", diff --git a/package.json b/package.json index 8a042d2251e6..2f92bf16e07c 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "@azure-tools/typespec-azure-portal-core": "0.50.0", "@azure-tools/typespec-azure-resource-manager": "0.50.0", "@azure-tools/typespec-azure-rulesets": "0.50.0", - "@azure-tools/typespec-client-generator-cli": "0.15.1", + "@azure-tools/typespec-client-generator-cli": "0.15.3", "@azure-tools/typespec-client-generator-core": "0.50.0", "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", From 6cb4ba94df1df68d3344c90a012f7e25dc6951f3 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 21 Jan 2025 11:37:30 -0800 Subject: [PATCH 06/74] [engsys] npm update (#32252) --- package-lock.json | 676 ++++++++++++++-------------------------------- 1 file changed, 203 insertions(+), 473 deletions(-) diff --git a/package-lock.json b/package-lock.json index e6a772cb8b4e..418d41c86e04 100644 --- a/package-lock.json +++ b/package-lock.json @@ -58,9 +58,9 @@ } }, "eng/tools/node_modules/@vitest/coverage-v8": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.0.2.tgz", - "integrity": "sha512-U+hZYb0FtgNDb6B3E9piAHzXXIuxuBw2cd6Lvepc9sYYY4KjgiwCBmo3Sird9ZRu3ggLpLBTfw1ZRr77ipiSfw==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.0.3.tgz", + "integrity": "sha512-uVbJ/xhImdNtzPnLyxCZJMTeTIYdgcC2nWtBBBpR1H6z0w8m7D+9/zrDIx2nNxgMg9r+X8+RY2qVpUDeW2b3nw==", "dev": true, "license": "MIT", "dependencies": { @@ -81,8 +81,8 @@ "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "3.0.2", - "vitest": "3.0.2" + "@vitest/browser": "3.0.3", + "vitest": "3.0.3" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -124,9 +124,9 @@ "license": "MIT" }, "eng/tools/node_modules/vite": { - "version": "6.0.7", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.0.7.tgz", - "integrity": "sha512-RDt8r/7qx9940f8FcOIAH9PTViRrghKaK2K1jY3RaAURrEUbm9Du1mJ72G+jlhtG3WwodnfzY8ORQZbBavZEAQ==", + "version": "6.0.11", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.0.11.tgz", + "integrity": "sha512-4VL9mQPKoHy4+FE0NnRE/kbY51TOfaknxAjt3fJbGJxhIpBZiqVzlZDEesWWsuREXHwNdAoOFZ9MkPEVXczHwg==", "dev": true, "license": "MIT", "dependencies": { @@ -196,19 +196,19 @@ } }, "eng/tools/node_modules/vitest": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.0.2.tgz", - "integrity": "sha512-5bzaHakQ0hmVVKLhfh/jXf6oETDBtgPo8tQCHYB+wftNgFJ+Hah67IsWc8ivx4vFL025Ow8UiuTf4W57z4izvQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.0.3.tgz", + "integrity": "sha512-dWdwTFUW9rcnL0LyF2F+IfvNQWB0w9DERySCk8VMG75F8k25C7LsZoh6XfCjPvcR8Nb+Lqi9JKr6vnzH7HSrpQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/expect": "3.0.2", - "@vitest/mocker": "3.0.2", - "@vitest/pretty-format": "^3.0.2", - "@vitest/runner": "3.0.2", - "@vitest/snapshot": "3.0.2", - "@vitest/spy": "3.0.2", - "@vitest/utils": "3.0.2", + "@vitest/expect": "3.0.3", + "@vitest/mocker": "3.0.3", + "@vitest/pretty-format": "^3.0.3", + "@vitest/runner": "3.0.3", + "@vitest/snapshot": "3.0.3", + "@vitest/spy": "3.0.3", + "@vitest/utils": "3.0.3", "chai": "^5.1.2", "debug": "^4.4.0", "expect-type": "^1.1.0", @@ -220,7 +220,7 @@ "tinypool": "^1.0.2", "tinyrainbow": "^2.0.0", "vite": "^5.0.0 || ^6.0.0", - "vite-node": "3.0.2", + "vite-node": "3.0.3", "why-is-node-running": "^2.3.0" }, "bin": { @@ -235,8 +235,8 @@ "peerDependencies": { "@edge-runtime/vm": "*", "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", - "@vitest/browser": "3.0.2", - "@vitest/ui": "3.0.2", + "@vitest/browser": "3.0.3", + "@vitest/ui": "3.0.3", "happy-dom": "*", "jsdom": "*" }, @@ -262,13 +262,13 @@ } }, "eng/tools/node_modules/vitest/node_modules/@vitest/mocker": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.0.2.tgz", - "integrity": "sha512-Hr09FoBf0jlwwSyzIF4Xw31OntpO3XtZjkccpcBf8FeVW3tpiyKlkeUzxS/txzHqpUCNIX157NaTySxedyZLvA==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.0.3.tgz", + "integrity": "sha512-XT2XBc4AN9UdaxJAeIlcSZ0ILi/GzmG5G8XSly4gaiqIvPV3HMTSIDZWJVX6QRJ0PX1m+W8Cy0K9ByXNb/bPIA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "3.0.2", + "@vitest/spy": "3.0.3", "estree-walker": "^3.0.3", "magic-string": "^0.30.17" }, @@ -509,288 +509,31 @@ } }, "node_modules/@autorest/openapi-to-typespec": { - "version": "0.10.6", - "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.6.tgz", - "integrity": "sha512-XyggoIBpYb+abgKCB/8O6QEF6nutKhFmA52rpOZ6Om3gz6FtbBas3WVRn/csFsUeZVOvJ1CUTOxTzY1v36okuw==", + "version": "0.10.7", + "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.7.tgz", + "integrity": "sha512-hOrZR5dazZjQiBO90MSi6N4PImHmi4zz8/ft+LqlUDISdiG4PlxlSh+KP5NL2Cq2PJ/It+9BlSXknlz2lM4/2Q==", "dev": true, "license": "MIT", "dependencies": { "@autorest/codemodel": "~4.20.0", "@autorest/extension-base": "~3.6.0", "@azure-tools/codegen": "~2.10.0", - "@azure-tools/typespec-autorest": "^0.49.0", - "@azure-tools/typespec-azure-core": "^0.49.0", - "@azure-tools/typespec-azure-resource-manager": "^0.49.0", - "@typespec/compiler": "^0.63.0", - "@typespec/http": "^0.63.0", - "@typespec/openapi": "^0.63.0", - "@typespec/openapi3": "^0.63.0", - "@typespec/prettier-plugin-typespec": "^0.63.0", - "@typespec/rest": "^0.63.0", - "@typespec/versioning": "^0.63.0", + "@azure-tools/typespec-autorest": "^0.50.0", + "@azure-tools/typespec-azure-core": "^0.50.0", + "@azure-tools/typespec-azure-resource-manager": "^0.50.0", + "@typespec/compiler": "^0.64.0", + "@typespec/http": "^0.64.0", + "@typespec/openapi": "^0.64.0", + "@typespec/openapi3": "^0.64.0", + "@typespec/prettier-plugin-typespec": "^0.64.0", + "@typespec/rest": "^0.64.0", + "@typespec/versioning": "^0.64.0", "change-case-all": "~2.1.0", "lodash": "~4.17.20", "pluralize": "^8.0.0", "prettier": "~3.1.0" } }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-autorest": { - "version": "0.49.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.49.0.tgz", - "integrity": "sha512-stwfhmEc3yPeXbM8yfLKVCtaX5mR0H+sL74Xy/eMdEWoJgiE3aJxkgRWESu/7/vo99vugzo/HRwIEO5ELnyfRg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.49.0", - "@azure-tools/typespec-azure-resource-manager": "~0.49.0", - "@azure-tools/typespec-client-generator-core": "~0.49.0", - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0", - "@typespec/openapi": "~0.63.0", - "@typespec/rest": "~0.63.0", - "@typespec/versioning": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-azure-core": { - "version": "0.49.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.49.0.tgz", - "integrity": "sha512-hNKy+aePmPkB1brHQkO1tsJXqXPzt/9ehy10dv0rKdp9xq5dE3yBctHF5Aj3Nr8kr8GRG5z4KYpYPbV5guoT5w==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0", - "@typespec/rest": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.49.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.49.0.tgz", - "integrity": "sha512-1xWuG8OBJDykYM6BFD2owV9WH+oC32zt7XteXA0T4nH2T+D+sEFKppkCOMtIjX7ENBAlecmbdwgSNTZYQf4vaw==", - "dev": true, - "license": "MIT", - "dependencies": { - "change-case": "~5.4.4", - "pluralize": "^8.0.0" - }, - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.49.0", - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0", - "@typespec/openapi": "~0.63.0", - "@typespec/rest": "~0.63.0", - "@typespec/versioning": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.49.1", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.49.1.tgz", - "integrity": "sha512-uAzlkYfL73lp1BnP8HMcIcS8iud7UnQzw6bf6FCUkKFO1B6wDwcvut3HfTtUj1kvw0XkiVJ0NkcxT0Dz0cylpQ==", - "dev": true, - "license": "MIT", - "peer": true, - "dependencies": { - "change-case": "~5.4.4", - "pluralize": "^8.0.0", - "yaml": "~2.5.1" - }, - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.49.0", - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0", - "@typespec/openapi": "~0.63.0", - "@typespec/rest": "~0.63.0", - "@typespec/versioning": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/compiler": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.63.0.tgz", - "integrity": "sha512-cC3YniwbFghn1fASX3r1IgNjMrwaY4gmzznkHT4f/NxE+HK4XoXWn4EG7287QgVMCaHUykzJCIfW9k7kIleW5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@babel/code-frame": "~7.25.7", - "ajv": "~8.17.1", - "change-case": "~5.4.4", - "globby": "~14.0.2", - "mustache": "~4.2.0", - "picocolors": "~1.1.1", - "prettier": "~3.3.3", - "prompts": "~2.4.2", - "semver": "^7.6.3", - "temporal-polyfill": "^0.2.5", - "vscode-languageserver": "~9.0.1", - "vscode-languageserver-textdocument": "~1.0.12", - "yaml": "~2.5.1", - "yargs": "~17.7.2" - }, - "bin": { - "tsp": "cmd/tsp.js", - "tsp-server": "cmd/tsp-server.js" - }, - "engines": { - "node": ">=18.0.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/compiler/node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", - "dev": true, - "license": "MIT", - "bin": { - "prettier": "bin/prettier.cjs" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/prettier/prettier?sponsor=1" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/http": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.63.0.tgz", - "integrity": "sha512-SYVbBmLPAPdWZfdMs0QlbpTnFREDnkINu2FR+0kRX12qzbRgpRbLsdhg59qx4TfKoh4IAPgSV+Fq84w7BWGsyQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0", - "@typespec/streams": "~0.63.0" - }, - "peerDependenciesMeta": { - "@typespec/streams": { - "optional": true - } - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/openapi": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.63.0.tgz", - "integrity": "sha512-/KzR60mj3P/LnNWd/QfH0KTN/If4+mjrsWNSB7/uab6c8Qu/lNsGlZDkmWq4EFiwBR7VmpdFz9FP7d/m3O+tGw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/openapi3": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.63.0.tgz", - "integrity": "sha512-HC8VeakPznXNn7euAyAxUFNsOcfSzM8tQwYPNUMWs0qGJqGgb6vjf5rShQmfgrCe5Y6zcMM2PPBuxaFV3xXYLw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@readme/openapi-parser": "~2.6.0", - "openapi-types": "~12.1.3", - "yaml": "~2.5.1" - }, - "bin": { - "tsp-openapi3": "cmd/tsp-openapi3.js" - }, - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0", - "@typespec/openapi": "~0.63.0", - "@typespec/versioning": "~0.63.0" - }, - "peerDependenciesMeta": { - "@typespec/xml": { - "optional": true - } - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/prettier-plugin-typespec": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/prettier-plugin-typespec/-/prettier-plugin-typespec-0.63.0.tgz", - "integrity": "sha512-ZVnTk1B/8EzqDjHbhkicP8lH5Zj+R7Ft0wv4N34Au3SzxNFCNMzMKuA+ie3GsbQYrYi3T7gBiotW+Xt0lPKSOA==", - "dev": true, - "license": "MIT", - "dependencies": { - "prettier": "~3.3.3" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/prettier-plugin-typespec/node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", - "dev": true, - "license": "MIT", - "bin": { - "prettier": "bin/prettier.cjs" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/prettier/prettier?sponsor=1" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/rest": { - "version": "0.63.1", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.63.1.tgz", - "integrity": "sha512-RQbTM+HGjCaNIWC0v72m5ulnuvLjuRigb7pH4QeRCvFtGPHos+WBv5SImkGrbYx3353OGR8dIi7lWe7aNwiDcQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0", - "@typespec/http": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/streams": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/streams/-/streams-0.63.0.tgz", - "integrity": "sha512-4vEd5jdpdaY2i9CDHwSRuiUNCJr+M/gUCwNsaGWgsJdrfR/lx8WX3Y27KcRDNVcRQF7nsOR4i28r4siWqrTM4w==", - "dev": true, - "license": "MIT", - "optional": true, - "peer": true, - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0" - } - }, - "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/versioning": { - "version": "0.63.0", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.63.0.tgz", - "integrity": "sha512-BPvmPL+g20yEmSA8XRfbIHdToNOjssq4QfwOU6D7kKLLXnZHFb1hmuwW0tf0Wa/lYgoaUC60ONAeoXgNT1ZOIQ==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=18.0.0" - }, - "peerDependencies": { - "@typespec/compiler": "~0.63.0" - } - }, "node_modules/@autorest/openapi-to-typespec/node_modules/prettier": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", @@ -807,19 +550,6 @@ "url": "https://github.com/prettier/prettier?sponsor=1" } }, - "node_modules/@autorest/openapi-to-typespec/node_modules/yaml": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.1.tgz", - "integrity": "sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q==", - "dev": true, - "license": "ISC", - "bin": { - "yaml": "bin.mjs" - }, - "engines": { - "node": ">= 14" - } - }, "node_modules/@autorest/schemas": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/@autorest/schemas/-/schemas-1.3.5.tgz", @@ -2868,9 +2598,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.30.1.tgz", - "integrity": "sha512-pSWY+EVt3rJ9fQ3IqlrEUtXh3cGqGtPDH1FQlNZehO2yYxCHEX1SPsz1M//NXwYfbTlcKr9WObLnJX9FsS9K1Q==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.31.0.tgz", + "integrity": "sha512-9NrR4033uCbUBRgvLcBrJofa2KY9DzxL2UKZ1/4xA/mnTNyhZCWBuD8X3tPm1n4KxcgaraOYgrFKSgwjASfmlA==", "cpu": [ "arm" ], @@ -2882,9 +2612,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.30.1.tgz", - "integrity": "sha512-/NA2qXxE3D/BRjOJM8wQblmArQq1YoBVJjrjoTSBS09jgUisq7bqxNHJ8kjCHeV21W/9WDGwJEWSN0KQ2mtD/w==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.31.0.tgz", + "integrity": "sha512-iBbODqT86YBFHajxxF8ebj2hwKm1k8PTBQSojSt3d1FFt1gN+xf4CowE47iN0vOSdnd+5ierMHBbu/rHc7nq5g==", "cpu": [ "arm64" ], @@ -2896,9 +2626,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.30.1.tgz", - "integrity": "sha512-r7FQIXD7gB0WJ5mokTUgUWPl0eYIH0wnxqeSAhuIwvnnpjdVB8cRRClyKLQr7lgzjctkbp5KmswWszlwYln03Q==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.31.0.tgz", + "integrity": "sha512-WHIZfXgVBX30SWuTMhlHPXTyN20AXrLH4TEeH/D0Bolvx9PjgZnn4H677PlSGvU6MKNsjCQJYczkpvBbrBnG6g==", "cpu": [ "arm64" ], @@ -2910,9 +2640,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.30.1.tgz", - "integrity": "sha512-x78BavIwSH6sqfP2xeI1hd1GpHL8J4W2BXcVM/5KYKoAD3nNsfitQhvWSw+TFtQTLZ9OmlF+FEInEHyubut2OA==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.31.0.tgz", + "integrity": "sha512-hrWL7uQacTEF8gdrQAqcDy9xllQ0w0zuL1wk1HV8wKGSGbKPVjVUv/DEwT2+Asabf8Dh/As+IvfdU+H8hhzrQQ==", "cpu": [ "x64" ], @@ -2924,9 +2654,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.30.1.tgz", - "integrity": "sha512-HYTlUAjbO1z8ywxsDFWADfTRfTIIy/oUlfIDmlHYmjUP2QRDTzBuWXc9O4CXM+bo9qfiCclmHk1x4ogBjOUpUQ==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.31.0.tgz", + "integrity": "sha512-S2oCsZ4hJviG1QjPY1h6sVJLBI6ekBeAEssYKad1soRFv3SocsQCzX6cwnk6fID6UQQACTjeIMB+hyYrFacRew==", "cpu": [ "arm64" ], @@ -2938,9 +2668,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.30.1.tgz", - "integrity": "sha512-1MEdGqogQLccphhX5myCJqeGNYTNcmTyaic9S7CG3JhwuIByJ7J05vGbZxsizQthP1xpVx7kd3o31eOogfEirw==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.31.0.tgz", + "integrity": "sha512-pCANqpynRS4Jirn4IKZH4tnm2+2CqCNLKD7gAdEjzdLGbH1iO0zouHz4mxqg0uEMpO030ejJ0aA6e1PJo2xrPA==", "cpu": [ "x64" ], @@ -2952,9 +2682,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.30.1.tgz", - "integrity": "sha512-PaMRNBSqCx7K3Wc9QZkFx5+CX27WFpAMxJNiYGAXfmMIKC7jstlr32UhTgK6T07OtqR+wYlWm9IxzennjnvdJg==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.31.0.tgz", + "integrity": "sha512-0O8ViX+QcBd3ZmGlcFTnYXZKGbFu09EhgD27tgTdGnkcYXLat4KIsBBQeKLR2xZDCXdIBAlWLkiXE1+rJpCxFw==", "cpu": [ "arm" ], @@ -2966,9 +2696,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.30.1.tgz", - "integrity": "sha512-B8Rcyj9AV7ZlEFqvB5BubG5iO6ANDsRKlhIxySXcF1axXYUyqwBok+XZPgIYGBgs7LDXfWfifxhw0Ik57T0Yug==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.31.0.tgz", + "integrity": "sha512-w5IzG0wTVv7B0/SwDnMYmbr2uERQp999q8FMkKG1I+j8hpPX2BYFjWe69xbhbP6J9h2gId/7ogesl9hwblFwwg==", "cpu": [ "arm" ], @@ -2980,9 +2710,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.30.1.tgz", - "integrity": "sha512-hqVyueGxAj3cBKrAI4aFHLV+h0Lv5VgWZs9CUGqr1z0fZtlADVV1YPOij6AhcK5An33EXaxnDLmJdQikcn5NEw==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.31.0.tgz", + "integrity": "sha512-JyFFshbN5xwy6fulZ8B/8qOqENRmDdEkcIMF0Zz+RsfamEW+Zabl5jAb0IozP/8UKnJ7g2FtZZPEUIAlUSX8cA==", "cpu": [ "arm64" ], @@ -2994,9 +2724,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.30.1.tgz", - "integrity": "sha512-i4Ab2vnvS1AE1PyOIGp2kXni69gU2DAUVt6FSXeIqUCPIR3ZlheMW3oP2JkukDfu3PsexYRbOiJrY+yVNSk9oA==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.31.0.tgz", + "integrity": "sha512-kpQXQ0UPFeMPmPYksiBL9WS/BDiQEjRGMfklVIsA0Sng347H8W2iexch+IEwaR7OVSKtr2ZFxggt11zVIlZ25g==", "cpu": [ "arm64" ], @@ -3008,9 +2738,9 @@ ] }, "node_modules/@rollup/rollup-linux-loongarch64-gnu": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.30.1.tgz", - "integrity": "sha512-fARcF5g296snX0oLGkVxPmysetwUk2zmHcca+e9ObOovBR++9ZPOhqFUM61UUZ2EYpXVPN1redgqVoBB34nTpQ==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.31.0.tgz", + "integrity": "sha512-pMlxLjt60iQTzt9iBb3jZphFIl55a70wexvo8p+vVFK+7ifTRookdoXX3bOsRdmfD+OKnMozKO6XM4zR0sHRrQ==", "cpu": [ "loong64" ], @@ -3022,9 +2752,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.30.1.tgz", - "integrity": "sha512-GLrZraoO3wVT4uFXh67ElpwQY0DIygxdv0BNW9Hkm3X34wu+BkqrDrkcsIapAY+N2ATEbvak0XQ9gxZtCIA5Rw==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.31.0.tgz", + "integrity": "sha512-D7TXT7I/uKEuWiRkEFbed1UUYZwcJDU4vZQdPTcepK7ecPhzKOYk4Er2YR4uHKme4qDeIh6N3XrLfpuM7vzRWQ==", "cpu": [ "ppc64" ], @@ -3036,9 +2766,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.30.1.tgz", - "integrity": "sha512-0WKLaAUUHKBtll0wvOmh6yh3S0wSU9+yas923JIChfxOaaBarmb/lBKPF0w/+jTVozFnOXJeRGZ8NvOxvk/jcw==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.31.0.tgz", + "integrity": "sha512-wal2Tc8O5lMBtoePLBYRKj2CImUCJ4UNGJlLwspx7QApYny7K1cUYlzQ/4IGQBLmm+y0RS7dwc3TDO/pmcneTw==", "cpu": [ "riscv64" ], @@ -3050,9 +2780,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.30.1.tgz", - "integrity": "sha512-GWFs97Ruxo5Bt+cvVTQkOJ6TIx0xJDD/bMAOXWJg8TCSTEK8RnFeOeiFTxKniTc4vMIaWvCplMAFBt9miGxgkA==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.31.0.tgz", + "integrity": "sha512-O1o5EUI0+RRMkK9wiTVpk2tyzXdXefHtRTIjBbmFREmNMy7pFeYXCFGbhKFwISA3UOExlo5GGUuuj3oMKdK6JQ==", "cpu": [ "s390x" ], @@ -3064,9 +2794,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.30.1.tgz", - "integrity": "sha512-UtgGb7QGgXDIO+tqqJ5oZRGHsDLO8SlpE4MhqpY9Llpzi5rJMvrK6ZGhsRCST2abZdBqIBeXW6WPD5fGK5SDwg==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.31.0.tgz", + "integrity": "sha512-zSoHl356vKnNxwOWnLd60ixHNPRBglxpv2g7q0Cd3Pmr561gf0HiAcUBRL3S1vPqRC17Zo2CX/9cPkqTIiai1g==", "cpu": [ "x64" ], @@ -3078,9 +2808,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.30.1.tgz", - "integrity": "sha512-V9U8Ey2UqmQsBT+xTOeMzPzwDzyXmnAoO4edZhL7INkwQcaW1Ckv3WJX3qrrp/VHaDkEWIBWhRwP47r8cdrOow==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.31.0.tgz", + "integrity": "sha512-ypB/HMtcSGhKUQNiFwqgdclWNRrAYDH8iMYH4etw/ZlGwiTVxBz2tDrGRrPlfZu6QjXwtd+C3Zib5pFqID97ZA==", "cpu": [ "x64" ], @@ -3092,9 +2822,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.30.1.tgz", - "integrity": "sha512-WabtHWiPaFF47W3PkHnjbmWawnX/aE57K47ZDT1BXTS5GgrBUEpvOzq0FI0V/UYzQJgdb8XlhVNH8/fwV8xDjw==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.31.0.tgz", + "integrity": "sha512-JuhN2xdI/m8Hr+aVO3vspO7OQfUFO6bKLIRTAy0U15vmWjnZDLrEgCZ2s6+scAYaQVpYSh9tZtRijApw9IXyMw==", "cpu": [ "arm64" ], @@ -3106,9 +2836,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.30.1.tgz", - "integrity": "sha512-pxHAU+Zv39hLUTdQQHUVHf4P+0C47y/ZloorHpzs2SXMRqeAWmGghzAhfOlzFHHwjvgokdFAhC4V+6kC1lRRfw==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.31.0.tgz", + "integrity": "sha512-U1xZZXYkvdf5MIWmftU8wrM5PPXzyaY1nGCI4KI4BFfoZxHamsIe+BtnPLIvvPykvQWlVbqUXdLa4aJUuilwLQ==", "cpu": [ "ia32" ], @@ -3120,9 +2850,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.30.1.tgz", - "integrity": "sha512-D6qjsXGcvhTjv0kI4fU8tUuBDF/Ueee4SVX79VfNDXZa64TfCW1Slkb6Z7O1p7vflqZjcmOVdZlqf8gvJxc6og==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.31.0.tgz", + "integrity": "sha512-ul8rnCsUumNln5YWwz0ted2ZHFhzhRRnkpBZ+YRuHoRAlUji9KChpOUOndY7uykrPEPXVbHLlsdo6v5yXo/TXw==", "cpu": [ "x64" ], @@ -3530,17 +3260,17 @@ "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.20.0.tgz", - "integrity": "sha512-naduuphVw5StFfqp4Gq4WhIBE2gN1GEmMUExpJYknZJdRnc+2gDzB8Z3+5+/Kv33hPQRDGzQO/0opHE72lZZ6A==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.21.0.tgz", + "integrity": "sha512-eTH+UOR4I7WbdQnG4Z48ebIA6Bgi7WO8HvFEneeYBxG8qCOYgTOFPSg6ek9ITIDvGjDQzWHcoWHCDO2biByNzA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.20.0", - "@typescript-eslint/type-utils": "8.20.0", - "@typescript-eslint/utils": "8.20.0", - "@typescript-eslint/visitor-keys": "8.20.0", + "@typescript-eslint/scope-manager": "8.21.0", + "@typescript-eslint/type-utils": "8.21.0", + "@typescript-eslint/utils": "8.21.0", + "@typescript-eslint/visitor-keys": "8.21.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -3560,16 +3290,16 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.20.0.tgz", - "integrity": "sha512-gKXG7A5HMyjDIedBi6bUrDcun8GIjnI8qOwVLiY3rx6T/sHP/19XLJOnIq/FgQvWLHja5JN/LSE7eklNBr612g==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.21.0.tgz", + "integrity": "sha512-Wy+/sdEH9kI3w9civgACwabHbKl+qIOu0uFZ9IMKzX3Jpv9og0ZBJrZExGrPpFAY7rWsXuxs5e7CPPP17A4eYA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.20.0", - "@typescript-eslint/types": "8.20.0", - "@typescript-eslint/typescript-estree": "8.20.0", - "@typescript-eslint/visitor-keys": "8.20.0", + "@typescript-eslint/scope-manager": "8.21.0", + "@typescript-eslint/types": "8.21.0", + "@typescript-eslint/typescript-estree": "8.21.0", + "@typescript-eslint/visitor-keys": "8.21.0", "debug": "^4.3.4" }, "engines": { @@ -3585,14 +3315,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.20.0.tgz", - "integrity": "sha512-J7+VkpeGzhOt3FeG1+SzhiMj9NzGD/M6KoGn9f4dbz3YzK9hvbhVTmLj/HiTp9DazIzJ8B4XcM80LrR9Dm1rJw==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.21.0.tgz", + "integrity": "sha512-G3IBKz0/0IPfdeGRMbp+4rbjfSSdnGkXsM/pFZA8zM9t9klXDnB/YnKOBQ0GoPmoROa4bCq2NeHgJa5ydsQ4mA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.20.0", - "@typescript-eslint/visitor-keys": "8.20.0" + "@typescript-eslint/types": "8.21.0", + "@typescript-eslint/visitor-keys": "8.21.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -3603,14 +3333,14 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.20.0.tgz", - "integrity": "sha512-bPC+j71GGvA7rVNAHAtOjbVXbLN5PkwqMvy1cwGeaxUoRQXVuKCebRoLzm+IPW/NtFFpstn1ummSIasD5t60GA==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.21.0.tgz", + "integrity": "sha512-95OsL6J2BtzoBxHicoXHxgk3z+9P3BEcQTpBKriqiYzLKnM2DeSqs+sndMKdamU8FosiadQFT3D+BSL9EKnAJQ==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "8.20.0", - "@typescript-eslint/utils": "8.20.0", + "@typescript-eslint/typescript-estree": "8.21.0", + "@typescript-eslint/utils": "8.21.0", "debug": "^4.3.4", "ts-api-utils": "^2.0.0" }, @@ -3627,9 +3357,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.20.0.tgz", - "integrity": "sha512-cqaMiY72CkP+2xZRrFt3ExRBu0WmVitN/rYPZErA80mHjHx/Svgp8yfbzkJmDoQ/whcytOPO9/IZXnOc+wigRA==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.21.0.tgz", + "integrity": "sha512-PAL6LUuQwotLW2a8VsySDBwYMm129vFm4tMVlylzdoTybTHaAi0oBp7Ac6LhSrHHOdLM3efH+nAR6hAWoMF89A==", "dev": true, "license": "MIT", "engines": { @@ -3641,14 +3371,14 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.20.0.tgz", - "integrity": "sha512-Y7ncuy78bJqHI35NwzWol8E0X7XkRVS4K4P4TCyzWkOJih5NDvtoRDW4Ba9YJJoB2igm9yXDdYI/+fkiiAxPzA==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.21.0.tgz", + "integrity": "sha512-x+aeKh/AjAArSauz0GiQZsjT8ciadNMHdkUSwBB9Z6PrKc/4knM4g3UfHml6oDJmKC88a6//cdxnO/+P2LkMcg==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.20.0", - "@typescript-eslint/visitor-keys": "8.20.0", + "@typescript-eslint/types": "8.21.0", + "@typescript-eslint/visitor-keys": "8.21.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", @@ -3694,16 +3424,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.20.0.tgz", - "integrity": "sha512-dq70RUw6UK9ei7vxc4KQtBRk7qkHZv447OUZ6RPQMQl71I3NZxQJX/f32Smr+iqWrB02pHKn2yAdHBb0KNrRMA==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.21.0.tgz", + "integrity": "sha512-xcXBfcq0Kaxgj7dwejMbFyq7IOHgpNMtVuDveK7w3ZGwG9owKzhALVwKpTF2yrZmEwl9SWdetf3fxNzJQaVuxw==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.20.0", - "@typescript-eslint/types": "8.20.0", - "@typescript-eslint/typescript-estree": "8.20.0" + "@typescript-eslint/scope-manager": "8.21.0", + "@typescript-eslint/types": "8.21.0", + "@typescript-eslint/typescript-estree": "8.21.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -3718,13 +3448,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.20.0.tgz", - "integrity": "sha512-v/BpkeeYAsPkKCkR8BDwcno0llhzWVqPOamQrAEMdpZav2Y9OVjd9dwJyBLJWwf335B5DmlifECIkZRJCaGaHA==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.21.0.tgz", + "integrity": "sha512-BkLMNpdV6prozk8LlyK/SOoWLmUFi+ZD+pcqti9ILCbVvHGk1ui1g4jJOc2WDLaeExz2qWwojxlPce5PljcT3w==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.20.0", + "@typescript-eslint/types": "8.21.0", "eslint-visitor-keys": "^4.2.0" }, "engines": { @@ -3908,14 +3638,14 @@ } }, "node_modules/@vitest/expect": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.0.2.tgz", - "integrity": "sha512-dKSHLBcoZI+3pmP5hiZ7I5grNru2HRtEW8Z5Zp4IXog8QYcxhlox7JUPyIIFWfN53+3HW3KPLIl6nSzUGgKSuQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.0.3.tgz", + "integrity": "sha512-SbRCHU4qr91xguu+dH3RUdI5dC86zm8aZWydbp961aIR7G8OYNN6ZiayFuf9WAngRbFOfdrLHCGgXTj3GtoMRQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "3.0.2", - "@vitest/utils": "3.0.2", + "@vitest/spy": "3.0.3", + "@vitest/utils": "3.0.3", "chai": "^5.1.2", "tinyrainbow": "^2.0.0" }, @@ -3924,9 +3654,9 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.0.2.tgz", - "integrity": "sha512-yBohcBw/T/p0/JRgYD+IYcjCmuHzjC3WLAKsVE4/LwiubzZkE8N49/xIQ/KGQwDRA8PaviF8IRO8JMWMngdVVQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.0.3.tgz", + "integrity": "sha512-gCrM9F7STYdsDoNjGgYXKPq4SkSxwwIU5nkaQvdUxiQ0EcNlez+PdKOVIsUJvh9P9IeIFmjn4IIREWblOBpP2Q==", "dev": true, "license": "MIT", "dependencies": { @@ -3937,13 +3667,13 @@ } }, "node_modules/@vitest/runner": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.0.2.tgz", - "integrity": "sha512-GHEsWoncrGxWuW8s405fVoDfSLk6RF2LCXp6XhevbtDjdDme1WV/eNmUueDfpY1IX3MJaCRelVCEXsT9cArfEg==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.0.3.tgz", + "integrity": "sha512-Rgi2kOAk5ZxWZlwPguRJFOBmWs6uvvyAAR9k3MvjRvYrG7xYvKChZcmnnpJCS98311CBDMqsW9MzzRFsj2gX3g==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "3.0.2", + "@vitest/utils": "3.0.3", "pathe": "^2.0.1" }, "funding": { @@ -3951,13 +3681,13 @@ } }, "node_modules/@vitest/snapshot": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.0.2.tgz", - "integrity": "sha512-h9s67yD4+g+JoYG0zPCo/cLTabpDqzqNdzMawmNPzDStTiwxwkyYM1v5lWE8gmGv3SVJ2DcxA2NpQJZJv9ym3g==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.0.3.tgz", + "integrity": "sha512-kNRcHlI4txBGztuJfPEJ68VezlPAXLRT1u5UCx219TU3kOG2DplNxhWLwDf2h6emwmTPogzLnGVwP6epDaJN6Q==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.0.2", + "@vitest/pretty-format": "3.0.3", "magic-string": "^0.30.17", "pathe": "^2.0.1" }, @@ -3966,9 +3696,9 @@ } }, "node_modules/@vitest/spy": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.0.2.tgz", - "integrity": "sha512-8mI2iUn+PJFMT44e3ISA1R+K6ALVs47W6eriDTfXe6lFqlflID05MB4+rIFhmDSLBj8iBsZkzBYlgSkinxLzSQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.0.3.tgz", + "integrity": "sha512-7/dgux8ZBbF7lEIKNnEqQlyRaER9nkAL9eTmdKJkDO3hS8p59ATGwKOCUDHcBLKr7h/oi/6hP+7djQk8049T2A==", "dev": true, "license": "MIT", "dependencies": { @@ -3979,13 +3709,13 @@ } }, "node_modules/@vitest/utils": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.0.2.tgz", - "integrity": "sha512-Qu01ZYZlgHvDP02JnMBRpX43nRaZtNpIzw3C1clDXmn8eakgX6iQVGzTQ/NjkIr64WD8ioqOjkaYRVvHQI5qiw==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.0.3.tgz", + "integrity": "sha512-f+s8CvyzPtMFY1eZKkIHGhPsQgYo5qCm6O8KZoim9qm1/jT64qBgGpO5tHscNH6BzRHM+edLNOP+3vO8+8pE/A==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.0.2", + "@vitest/pretty-format": "3.0.3", "loupe": "^3.1.2", "tinyrainbow": "^2.0.0" }, @@ -4396,9 +4126,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001692", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001692.tgz", - "integrity": "sha512-A95VKan0kdtrsnMubMKxEKUKImOPSuCpYgxSQBo036P5YYgVIcOYJEgt/txJWqObiRQeISNCfef9nvlQ0vbV7A==", + "version": "1.0.30001695", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001695.tgz", + "integrity": "sha512-vHyLade6wTgI2u1ec3WQBxv+2BrTERV28UXQu9LO6lZ9pYeMk34vjXFLOxo1A4UBA8XTL4njRQZdno/yYaSmWw==", "dev": true, "funding": [ { @@ -4936,9 +4666,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.83", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.83.tgz", - "integrity": "sha512-LcUDPqSt+V0QmI47XLzZrz5OqILSMGsPFkDYus22rIbgorSvBYEFqq854ltTmUdHkY92FSdAAvsh4jWEULMdfQ==", + "version": "1.5.84", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.84.tgz", + "integrity": "sha512-I+DQ8xgafao9Ha6y0qjHHvpZ9OfyA1qKlkHkjywxzniORU2awxyz7f/iVJcULmrF2yrM3nHQf+iDjJtbbexd/g==", "dev": true, "license": "ISC" }, @@ -5586,9 +5316,9 @@ "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.5.tgz", - "integrity": "sha512-5JnBCWpFlMo0a3ciDy/JckMzzv1U9coZrIhedq+HXxxUfDTAiS0LA8OKVao4G9BxmCVck/jtA5r3KAtRWEyD8Q==", + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.6.tgz", + "integrity": "sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw==", "dev": true, "funding": [ { @@ -8642,9 +8372,9 @@ } }, "node_modules/rollup": { - "version": "4.30.1", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.30.1.tgz", - "integrity": "sha512-mlJ4glW020fPuLi7DkM/lN97mYEZGWeqBnrljzN0gs7GLctqX3lNWxKQ7Gl712UAX+6fog/L3jh4gb7R6aVi3w==", + "version": "4.31.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.31.0.tgz", + "integrity": "sha512-9cCE8P4rZLx9+PjoyqHLs31V9a9Vpvfo4qNcs6JCiGWYhw2gijSetFbH6SSy1whnkgcefnUwr8sad7tgqsGvnw==", "dev": true, "license": "MIT", "dependencies": { @@ -8658,25 +8388,25 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.30.1", - "@rollup/rollup-android-arm64": "4.30.1", - "@rollup/rollup-darwin-arm64": "4.30.1", - "@rollup/rollup-darwin-x64": "4.30.1", - "@rollup/rollup-freebsd-arm64": "4.30.1", - "@rollup/rollup-freebsd-x64": "4.30.1", - "@rollup/rollup-linux-arm-gnueabihf": "4.30.1", - "@rollup/rollup-linux-arm-musleabihf": "4.30.1", - "@rollup/rollup-linux-arm64-gnu": "4.30.1", - "@rollup/rollup-linux-arm64-musl": "4.30.1", - "@rollup/rollup-linux-loongarch64-gnu": "4.30.1", - "@rollup/rollup-linux-powerpc64le-gnu": "4.30.1", - "@rollup/rollup-linux-riscv64-gnu": "4.30.1", - "@rollup/rollup-linux-s390x-gnu": "4.30.1", - "@rollup/rollup-linux-x64-gnu": "4.30.1", - "@rollup/rollup-linux-x64-musl": "4.30.1", - "@rollup/rollup-win32-arm64-msvc": "4.30.1", - "@rollup/rollup-win32-ia32-msvc": "4.30.1", - "@rollup/rollup-win32-x64-msvc": "4.30.1", + "@rollup/rollup-android-arm-eabi": "4.31.0", + "@rollup/rollup-android-arm64": "4.31.0", + "@rollup/rollup-darwin-arm64": "4.31.0", + "@rollup/rollup-darwin-x64": "4.31.0", + "@rollup/rollup-freebsd-arm64": "4.31.0", + "@rollup/rollup-freebsd-x64": "4.31.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.31.0", + "@rollup/rollup-linux-arm-musleabihf": "4.31.0", + "@rollup/rollup-linux-arm64-gnu": "4.31.0", + "@rollup/rollup-linux-arm64-musl": "4.31.0", + "@rollup/rollup-linux-loongarch64-gnu": "4.31.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.31.0", + "@rollup/rollup-linux-riscv64-gnu": "4.31.0", + "@rollup/rollup-linux-s390x-gnu": "4.31.0", + "@rollup/rollup-linux-x64-gnu": "4.31.0", + "@rollup/rollup-linux-x64-musl": "4.31.0", + "@rollup/rollup-win32-arm64-msvc": "4.31.0", + "@rollup/rollup-win32-ia32-msvc": "4.31.0", + "@rollup/rollup-win32-x64-msvc": "4.31.0", "fsevents": "~2.3.2" } }, @@ -9482,15 +9212,15 @@ } }, "node_modules/typescript-eslint": { - "version": "8.20.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.20.0.tgz", - "integrity": "sha512-Kxz2QRFsgbWj6Xcftlw3Dd154b3cEPFqQC+qMZrMypSijPd4UanKKvoKDrJ4o8AIfZFKAF+7sMaEIR8mTElozA==", + "version": "8.21.0", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.21.0.tgz", + "integrity": "sha512-txEKYY4XMKwPXxNkN8+AxAdX6iIJAPiJbHE/FpQccs/sxw8Lf26kqwC3cn0xkHlW8kEbLhkhCsjWuMveaY9Rxw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/eslint-plugin": "8.20.0", - "@typescript-eslint/parser": "8.20.0", - "@typescript-eslint/utils": "8.20.0" + "@typescript-eslint/eslint-plugin": "8.21.0", + "@typescript-eslint/parser": "8.21.0", + "@typescript-eslint/utils": "8.21.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -9681,9 +9411,9 @@ } }, "node_modules/vite-node": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.0.2.tgz", - "integrity": "sha512-hsEQerBAHvVAbv40m3TFQe/lTEbOp7yDpyqMJqr2Tnd+W58+DEYOt+fluQgekOePcsNBmR77lpVAnIU2Xu4SvQ==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.0.3.tgz", + "integrity": "sha512-0sQcwhwAEw/UJGojbhOrnq3HtiZ3tC7BzpAa0lx3QaTX0S3YX70iGcik25UBdB96pmdwjyY2uyKNYruxCDmiEg==", "dev": true, "license": "MIT", "dependencies": { @@ -9725,9 +9455,9 @@ "peer": true }, "node_modules/vite-node/node_modules/vite": { - "version": "6.0.7", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.0.7.tgz", - "integrity": "sha512-RDt8r/7qx9940f8FcOIAH9PTViRrghKaK2K1jY3RaAURrEUbm9Du1mJ72G+jlhtG3WwodnfzY8ORQZbBavZEAQ==", + "version": "6.0.11", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.0.11.tgz", + "integrity": "sha512-4VL9mQPKoHy4+FE0NnRE/kbY51TOfaknxAjt3fJbGJxhIpBZiqVzlZDEesWWsuREXHwNdAoOFZ9MkPEVXczHwg==", "dev": true, "license": "MIT", "dependencies": { From 67c5a94ab93ef77405abfcc6b20262da46fe8a46 Mon Sep 17 00:00:00 2001 From: Renyx1219 <90930682+Renyx1219@users.noreply.github.com> Date: Tue, 21 Jan 2025 11:45:29 -0800 Subject: [PATCH 07/74] Add sdk options in tspconfig.yaml. (#32222) Co-authored-by: Yixiong Ren --- .../DatabaseWatcher.Management/tspconfig.yaml | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml b/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml index 1178a6c18d05..6bb38d6c5cdc 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml +++ b/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/databasewatcher" emit: - "@azure-tools/typespec-autorest" options: @@ -9,6 +12,45 @@ options: arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/Watcher.json" use-read-only-status-schema: true + "@azure-tools/typespec-csharp": + clear-output-folder: true + flavor: azure + model-namespace: false + namespace: "Azure.ResourceManager.DatabaseWatcher" + package-dir: "Azure.ResourceManager.DatabaseWatcher" + "@azure-tools/typespec-python": + flavor: azure + generate-sample: true + generate-test: true + package-dir: "azure-mgmt-databasewatcher" + package-name: "azure-mgmt-databasewatcher" + "@azure-tools/typespec-java": + flavor: azure + namespace: "com.azure.resourcemanager.databasewatcher" + package-dir: "azure-resourcemanager-databasewatcher" + service-name: "Database Watcher" + "@azure-tools/typespec-ts": + azureSdkForJs: true + enableOperationGroup: true + experimentalExtensibleEnums: true + flavor: azure + generateMetadata: true + hierarchyClient: false + isModularLibrary: true + package-dir: "arm-databasewatcher" + packageDetails: + name: "@azure/arm-databasewatcher" + "@azure-tools/typespec-go": + fix-const-stuttering: true + flavor: azure + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true + service-dir: "sdk/resourcemanager/databasewatcher" + package-dir: "armdatabasewatcher" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From eafbc4a150a4c372900449dcb33683bef5a25705 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 21 Jan 2025 12:12:56 -0800 Subject: [PATCH 08/74] [engsys] Pin runner images (#32254) - Eliminates noisy warnings about image upgrades - Easy to update when we want with a single search-and-replace --- .github/workflows/SDK-Suppressions-Label.yaml | 14 +++--- .../workflows/_reusable-eng-tools-test.yaml | 10 ++--- .github/workflows/protected-files.yaml | 2 +- .github/workflows/spelling-all.yaml | 2 +- .github/workflows/spelling.yaml | 2 +- .github/workflows/typespec-requirement.yaml | 45 +++++++++---------- .../workflows/typespec-validation-all.yaml | 6 +-- .github/workflows/typespec-validation.yaml | 26 +++++------ .github/workflows/update-labels.yaml | 24 +++++----- 9 files changed, 65 insertions(+), 66 deletions(-) diff --git a/.github/workflows/SDK-Suppressions-Label.yaml b/.github/workflows/SDK-Suppressions-Label.yaml index 2983c88c04c0..47d53d2b05fe 100644 --- a/.github/workflows/SDK-Suppressions-Label.yaml +++ b/.github/workflows/SDK-Suppressions-Label.yaml @@ -6,11 +6,11 @@ on: - main - RPSaaSMaster - release* - + jobs: process-sdk-suppressions-labels: name: Sdk Suppressions - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 permissions: contents: read steps: @@ -56,7 +56,7 @@ jobs: GITHUB_PULL_REQUEST_LABELS: ${{ steps.fetch-pullRequest-context.outputs.prLabels }} run: | node eng/tools/sdk-suppressions/cmd/sdk-suppressions-label.js HEAD^ HEAD "$GITHUB_PULL_REQUEST_CHANGE_FILES" "$GITHUB_PULL_REQUEST_LABELS" - + OUTPUT=$(cat $OUTPUT_FILE) echo "Script output labels: $OUTPUT" @@ -74,7 +74,7 @@ jobs: done # No Action or Add/Remove label ​​according to step run-suppressions-script output - # e.g. + # e.g. # If the output of the step does not include the BreakingChange-Go-Sdk-Suppression, no action will be taken. # If the step's output is "BreakingChange-Go-Sdk-Suppression='true'", the label "BreakingChange-Go-Sdk-Suppression" will be applied to the PR. # If the step's output is "BreakingChange-Go-Sdk-Suppression='false'", the label "BreakingChange-Go-Sdk-Suppression" will be removed from the PR. @@ -84,21 +84,21 @@ jobs: with: name: "BreakingChange-Go-Sdk-Suppression" value: "${{ steps.run-suppressions-script.outputs.BreakingChange-Go-Sdk-Suppression == 'true' }}" - + - uses: ./.github/actions/add-label-artifact name: Upload artifact with results java if: ${{ steps.run-suppressions-script.outputs.BreakingChange-Java-Sdk-Suppression }} with: name: "BreakingChange-Java-Sdk-Suppression" value: "${{ steps.run-suppressions-script.outputs.BreakingChange-Java-Sdk-Suppression == 'true' }}" - + - uses: ./.github/actions/add-label-artifact name: Upload artifact with results js if: ${{ steps.run-suppressions-script.outputs.BreakingChange-JavaScript-Sdk-Suppression }} with: name: "BreakingChange-JavaScript-Sdk-Suppression" value: "${{ steps.run-suppressions-script.outputs.BreakingChange-JavaScript-Sdk-Suppression == 'true' }}" - + - uses: ./.github/actions/add-label-artifact name: Upload artifact with results python if: ${{ steps.run-suppressions-script.outputs.BreakingChange-Python-Sdk-Suppression }} diff --git a/.github/workflows/_reusable-eng-tools-test.yaml b/.github/workflows/_reusable-eng-tools-test.yaml index 45344c1b00f3..56758dd53fb1 100644 --- a/.github/workflows/_reusable-eng-tools-test.yaml +++ b/.github/workflows/_reusable-eng-tools-test.yaml @@ -24,15 +24,15 @@ jobs: test: strategy: matrix: - os: [ubuntu-latest, windows-latest] + os: [ubuntu, windows] node-version: [18, 22] exclude: - - os: ubuntu-latest + - os: ubuntu node-version: 22 - - os: windows-latest + - os: windows node-version: 18 - runs-on: ${{ matrix.os }} + runs-on: ${{ fromJSON('{"ubuntu":"ubuntu-24.04", "windows":"windows-2022"}')[matrix.os] }} steps: - if: runner.os == 'Windows' @@ -63,7 +63,7 @@ jobs: - run: npm run prettier if: inputs.prettier == true shell: pwsh - working-directory: ./eng/tools/${{ inputs.package }} + working-directory: ./eng/tools/${{ inputs.package }} - run: npm run test:ci shell: pwsh diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 71671523be1b..fe6d726d5664 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -10,7 +10,7 @@ jobs: protected-files: name: Protected Files - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: # Since check is required, the job must pass instead of being skipped diff --git a/.github/workflows/spelling-all.yaml b/.github/workflows/spelling-all.yaml index 8f461a4ba9b6..1e5265e6a08f 100644 --- a/.github/workflows/spelling-all.yaml +++ b/.github/workflows/spelling-all.yaml @@ -14,7 +14,7 @@ on: jobs: spellcheck: name: SpellCheck - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - name: Checkout repository diff --git a/.github/workflows/spelling.yaml b/.github/workflows/spelling.yaml index f1e0e6af5faf..d13ff43ee2f5 100644 --- a/.github/workflows/spelling.yaml +++ b/.github/workflows/spelling.yaml @@ -5,7 +5,7 @@ on: pull_request jobs: spellcheck: name: SpellCheck - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - name: Checkout repository diff --git a/.github/workflows/typespec-requirement.yaml b/.github/workflows/typespec-requirement.yaml index 47909f268cfd..37a133a79e04 100644 --- a/.github/workflows/typespec-requirement.yaml +++ b/.github/workflows/typespec-requirement.yaml @@ -6,28 +6,27 @@ jobs: TypeSpec-Requirement: name: TypeSpec Requirement - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 - with: - # Required since "HEAD^" is passed to TypeSpec-Requirement.ps1 - fetch-depth: 2 - - - name: Setup Node and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci - - - run: | - eng/scripts/TypeSpec-Requirement.ps1 ` - -BaseCommitish HEAD^ ` - -TargetCommitish HEAD ` - id: tsr-ps1 - shell: pwsh - - # Always add label artifact, even if "brownfield=false", to ensure label is removed when necessary - - uses: ./.github/actions/add-label-artifact - name: Upload artifact with results - with: - name: "brownfield" - value: "${{ steps.tsr-ps1.outputs.brownfield == 'true' }}" - + - uses: actions/checkout@v4 + with: + # Required since "HEAD^" is passed to TypeSpec-Requirement.ps1 + fetch-depth: 2 + + - name: Setup Node and run `npm ci` + uses: ./.github/actions/setup-node-npm-ci + + - run: | + eng/scripts/TypeSpec-Requirement.ps1 ` + -BaseCommitish HEAD^ ` + -TargetCommitish HEAD ` + id: tsr-ps1 + shell: pwsh + + # Always add label artifact, even if "brownfield=false", to ensure label is removed when necessary + - uses: ./.github/actions/add-label-artifact + name: Upload artifact with results + with: + name: "brownfield" + value: "${{ steps.tsr-ps1.outputs.brownfield == 'true' }}" diff --git a/.github/workflows/typespec-validation-all.yaml b/.github/workflows/typespec-validation-all.yaml index c342e1bbd004..f2fff0e2a180 100644 --- a/.github/workflows/typespec-validation-all.yaml +++ b/.github/workflows/typespec-validation-all.yaml @@ -28,7 +28,7 @@ on: schedule: # Run 4x/day - - cron: '0 0,6,12,18 * * *' + - cron: "0 0,6,12,18 * * *" workflow_dispatch: @@ -53,7 +53,7 @@ jobs: # total-shards must be an accurate count of the number of shards total-shards: [3] - runs-on: ${{ matrix.os }}-latest + runs-on: ${{ fromJSON('{"ubuntu":"ubuntu-24.04", "windows":"windows-2022"}')[matrix.os] }} steps: - name: Enable git long paths @@ -67,7 +67,7 @@ jobs: - name: Setup Node and run `npm ci` uses: ./.github/actions/setup-node-npm-ci - + - name: Validate All Specs run: | # Keep processing when errors are written. Nonzero exit will mark the diff --git a/.github/workflows/typespec-validation.yaml b/.github/workflows/typespec-validation.yaml index 1029b85ae247..53b804d4a00d 100644 --- a/.github/workflows/typespec-validation.yaml +++ b/.github/workflows/typespec-validation.yaml @@ -5,21 +5,21 @@ on: pull_request jobs: typespec-validation: name: TypeSpec Validation - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 2 + - uses: actions/checkout@v4 + with: + fetch-depth: 2 - - name: Setup Node and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci + - name: Setup Node and run `npm ci` + uses: ./.github/actions/setup-node-npm-ci - - name: Validate Impacted Specs - run: | - # Keep processing when errors are written. Nonzero exit will mark the - # step as failed. - $ErrorActionPreference = 'Continue' + - name: Validate Impacted Specs + run: | + # Keep processing when errors are written. Nonzero exit will mark the + # step as failed. + $ErrorActionPreference = 'Continue' - ./eng/scripts/TypeSpec-Validation.ps1 -GitClean -Verbose - shell: pwsh + ./eng/scripts/TypeSpec-Validation.ps1 -GitClean -Verbose + shell: pwsh diff --git a/.github/workflows/update-labels.yaml b/.github/workflows/update-labels.yaml index 5fd9c8d151d7..ff09b5284a5f 100644 --- a/.github/workflows/update-labels.yaml +++ b/.github/workflows/update-labels.yaml @@ -37,18 +37,18 @@ jobs: contents: read pull-requests: write - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 - with: - sparse-checkout: | - .github + - uses: actions/checkout@v4 + with: + sparse-checkout: | + .github - - name: Update Labels - uses: ./.github/actions/update-labels - with: - owner: ${{ inputs.owner }} - repo: ${{ inputs.repo }} - issue_number: ${{ inputs.issue_number }} - run_id: ${{ inputs.run_id }} + - name: Update Labels + uses: ./.github/actions/update-labels + with: + owner: ${{ inputs.owner }} + repo: ${{ inputs.repo }} + issue_number: ${{ inputs.issue_number }} + run_id: ${{ inputs.run_id }} From 24e1f5199983c795c042e0ebd67ce519927f8bd0 Mon Sep 17 00:00:00 2001 From: Pan Shao <97225342+pshao25@users.noreply.github.com> Date: Wed, 22 Jan 2025 04:18:30 +0800 Subject: [PATCH 09/74] [engsys] Add package openapi-to-typespec (#32245) --- .github/dependabot.yml | 4 ++++ package-lock.json | 1 + package.json | 1 + 3 files changed, 6 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 22a9b9f7f4db..048ae07fd431 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -22,6 +22,10 @@ updates: typespec-client-generator-cli: patterns: - "@azure-tools/typespec-client-generator-cli" + # Ships separately from other typespec packages + openapi-to-typespec: + patterns: + - "@autorest/openapi-to-typespec" typespec: patterns: - "*typespec*" diff --git a/package-lock.json b/package-lock.json index 418d41c86e04..38713b8f0160 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,6 +6,7 @@ "": { "name": "azure-rest-api-specs", "devDependencies": { + "@autorest/openapi-to-typespec": "0.10.7", "@azure-tools/typespec-apiview": "0.5.0", "@azure-tools/typespec-autorest": "0.50.0", "@azure-tools/typespec-azure-core": "0.50.0", diff --git a/package.json b/package.json index 2f92bf16e07c..8977be87fc4b 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,7 @@ "@azure-tools/typespec-client-generator-core": "0.50.0", "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", + "@autorest/openapi-to-typespec": "0.10.7", "@typespec/compiler": "0.64.0", "@typespec/http": "0.64.0", "@typespec/openapi": "0.64.0", From ebf16a6d3e26f57142f310e59ccb3855ee70e4d6 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Tue, 21 Jan 2025 13:56:41 -0800 Subject: [PATCH 10/74] handle only deleted files in a - pullrequest build (#32219) Co-authored-by: Scott Beddall --- eng/common/scripts/Generate-PR-Diff.ps1 | 2 ++ eng/common/scripts/Package-Properties.ps1 | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/eng/common/scripts/Generate-PR-Diff.ps1 b/eng/common/scripts/Generate-PR-Diff.ps1 index e010e176399d..4e34032c47c8 100644 --- a/eng/common/scripts/Generate-PR-Diff.ps1 +++ b/eng/common/scripts/Generate-PR-Diff.ps1 @@ -48,6 +48,7 @@ $changedFiles = @() $changedServices = @() $changedFiles = Get-ChangedFiles -DiffPath $TargetPath +$deletedFiles = Get-ChangedFiles -DiffPath $TargetPath -DiffFilterType "D" if ($changedFiles) { $changedServices = Get-ChangedServices -ChangedFiles $changedFiles @@ -63,6 +64,7 @@ $result = [PSCustomObject]@{ "ChangedFiles" = $changedFiles "ChangedServices" = $changedServices "ExcludePaths" = $ExcludePaths + "DeletedFiles" = $deletedFiles "PRNumber" = if ($env:SYSTEM_PULLREQUEST_PULLREQUESTNUMBER) { $env:SYSTEM_PULLREQUEST_PULLREQUESTNUMBER } else { "-1" } } diff --git a/eng/common/scripts/Package-Properties.ps1 b/eng/common/scripts/Package-Properties.ps1 index bc7b5738e2d3..a23ee76bbda6 100644 --- a/eng/common/scripts/Package-Properties.ps1 +++ b/eng/common/scripts/Package-Properties.ps1 @@ -162,6 +162,14 @@ function Get-PrPkgProperties([string]$InputDiffJson) { $allPackageProperties = Get-AllPkgProperties $diff = Get-Content $InputDiffJson | ConvertFrom-Json $targetedFiles = $diff.ChangedFiles + + if ($diff.DeletedFiles) { + if (-not $targetedFiles) { + $targetedFiles = @() + } + $targetedFiles += $diff.DeletedFiles + } + # The exclude paths and the targeted files paths aren't full OS paths, they're # GitHub paths meaning they're relative to the repo root and slashes are forward # slashes "/". The ExcludePaths need to have a trailing slash added in order From ae09132e6b8376159c1c2ca235c020b10226f66d Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 21 Jan 2025 14:22:27 -0800 Subject: [PATCH 11/74] [protected-files] Add root cspell files (#32258) --- .github/workflows/protected-files.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index fe6d726d5664..291d123b1694 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -29,7 +29,7 @@ jobs: run: | . eng/scripts/ChangedFiles-Functions.ps1 - $protectedFiles = @("package.json", "package-lock.json", ".github/*", "eng/*") + $protectedFiles = @("cspell.json", "cspell.yaml", "package.json", "package-lock.json", ".github/*", "eng/*") $changedFiles = @(Get-ChangedFiles -baseCommitish HEAD^ -targetCommitish HEAD -diffFilter "") $matchedFiles = @($changedFiles | Where-Object { $changedFile = $_; $protectedFiles | Where-Object { $changedFile -like $_ } }) From 9bc885271d3ad4d4d5697d221e7d25a80d09779d Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 21 Jan 2025 15:23:09 -0800 Subject: [PATCH 12/74] [engsys] Remove unnecessary ".github/package-lock.json" (#32260) --- .github/package-lock.json | 475 -------------------------------------- .gitignore | 3 +- 2 files changed, 1 insertion(+), 477 deletions(-) delete mode 100644 .github/package-lock.json diff --git a/.github/package-lock.json b/.github/package-lock.json deleted file mode 100644 index 9bf44423ccfa..000000000000 --- a/.github/package-lock.json +++ /dev/null @@ -1,475 +0,0 @@ -{ - "name": "scripts", - "lockfileVersion": 3, - "requires": true, - "packages": { - "": { - "devDependencies": { - "@octokit/webhooks-types": "^7.5.1", - "@types/github-script": "github:actions/github-script", - "@types/node": "^20.0.0", - "prettier": "^3.3.3" - } - }, - "node_modules/@actions/core": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz", - "integrity": "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==", - "dev": true, - "license": "MIT", - "dependencies": { - "@actions/exec": "^1.1.1", - "@actions/http-client": "^2.0.1" - } - }, - "node_modules/@actions/exec": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.1.1.tgz", - "integrity": "sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w==", - "dev": true, - "license": "MIT", - "dependencies": { - "@actions/io": "^1.0.1" - } - }, - "node_modules/@actions/github": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/@actions/github/-/github-6.0.0.tgz", - "integrity": "sha512-alScpSVnYmjNEXboZjarjukQEzgCRmjMv6Xj47fsdnqGS73bjJNDpiiXmp8jr0UZLdUB6d9jW63IcmddUP+l0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@actions/http-client": "^2.2.0", - "@octokit/core": "^5.0.1", - "@octokit/plugin-paginate-rest": "^9.0.0", - "@octokit/plugin-rest-endpoint-methods": "^10.0.0" - } - }, - "node_modules/@actions/glob": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/@actions/glob/-/glob-0.4.0.tgz", - "integrity": "sha512-+eKIGFhsFa4EBwaf/GMyzCdWrXWymGXfFmZU3FHQvYS8mPcHtTtZONbkcqqUMzw9mJ/pImEBFET1JNifhqGsAQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@actions/core": "^1.9.1", - "minimatch": "^3.0.4" - } - }, - "node_modules/@actions/http-client": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.2.3.tgz", - "integrity": "sha512-mx8hyJi/hjFvbPokCg4uRd4ZX78t+YyRPtnKWwIl+RzNaVuFpQHfmlGVfsKEJN8LwTCvL+DfVgAM04XaHkm6bA==", - "dev": true, - "license": "MIT", - "dependencies": { - "tunnel": "^0.0.6", - "undici": "^5.25.4" - } - }, - "node_modules/@actions/io": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz", - "integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q==", - "dev": true, - "license": "MIT" - }, - "node_modules/@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - } - }, - "node_modules/@octokit/auth-token": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-4.0.0.tgz", - "integrity": "sha512-tY/msAuJo6ARbK6SPIxZrPBms3xPbfwBrulZe0Wtr/DIY9lje2HeV1uoebShn6mx7SjCHif6EjMvoREj+gZ+SA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 18" - } - }, - "node_modules/@octokit/core": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/@octokit/core/-/core-5.2.0.tgz", - "integrity": "sha512-1LFfa/qnMQvEOAdzlQymH0ulepxbxnCYAKJZfMci/5XJyIHWgEYnDmgnKakbTh7CH2tFQ5O60oYDvns4i9RAIg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/auth-token": "^4.0.0", - "@octokit/graphql": "^7.1.0", - "@octokit/request": "^8.3.1", - "@octokit/request-error": "^5.1.0", - "@octokit/types": "^13.0.0", - "before-after-hook": "^2.2.0", - "universal-user-agent": "^6.0.0" - }, - "engines": { - "node": ">= 18" - } - }, - "node_modules/@octokit/endpoint": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-9.0.5.tgz", - "integrity": "sha512-ekqR4/+PCLkEBF6qgj8WqJfvDq65RH85OAgrtnVp1mSxaXF03u2xW/hUdweGS5654IlC0wkNYC18Z50tSYTAFw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/types": "^13.1.0", - "universal-user-agent": "^6.0.0" - }, - "engines": { - "node": ">= 18" - } - }, - "node_modules/@octokit/graphql": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-7.1.0.tgz", - "integrity": "sha512-r+oZUH7aMFui1ypZnAvZmn0KSqAUgE1/tUXIWaqUCa1758ts/Jio84GZuzsvUkme98kv0WFY8//n0J1Z+vsIsQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/request": "^8.3.0", - "@octokit/types": "^13.0.0", - "universal-user-agent": "^6.0.0" - }, - "engines": { - "node": ">= 18" - } - }, - "node_modules/@octokit/openapi-types": { - "version": "22.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz", - "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg==", - "dev": true, - "license": "MIT" - }, - "node_modules/@octokit/plugin-paginate-rest": { - "version": "9.2.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-9.2.1.tgz", - "integrity": "sha512-wfGhE/TAkXZRLjksFXuDZdmGnJQHvtU/joFQdweXUgzo1XwvBCD4o4+75NtFfjfLK5IwLf9vHTfSiU3sLRYpRw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/types": "^12.6.0" - }, - "engines": { - "node": ">= 18" - }, - "peerDependencies": { - "@octokit/core": "5" - } - }, - "node_modules/@octokit/plugin-paginate-rest/node_modules/@octokit/openapi-types": { - "version": "20.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", - "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@octokit/plugin-paginate-rest/node_modules/@octokit/types": { - "version": "12.6.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", - "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/openapi-types": "^20.0.0" - } - }, - "node_modules/@octokit/plugin-request-log": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-request-log/-/plugin-request-log-4.0.1.tgz", - "integrity": "sha512-GihNqNpGHorUrO7Qa9JbAl0dbLnqJVrV8OXe2Zm5/Y4wFkZQDfTreBzVmiRfJVfE4mClXdihHnbpyyO9FSX4HA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 18" - }, - "peerDependencies": { - "@octokit/core": "5" - } - }, - "node_modules/@octokit/plugin-rest-endpoint-methods": { - "version": "10.4.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-10.4.1.tgz", - "integrity": "sha512-xV1b+ceKV9KytQe3zCVqjg+8GTGfDYwaT1ATU5isiUyVtlVAO3HNdzpS4sr4GBx4hxQ46s7ITtZrAsxG22+rVg==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/types": "^12.6.0" - }, - "engines": { - "node": ">= 18" - }, - "peerDependencies": { - "@octokit/core": "5" - } - }, - "node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/openapi-types": { - "version": "20.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", - "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/types": { - "version": "12.6.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", - "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/openapi-types": "^20.0.0" - } - }, - "node_modules/@octokit/plugin-retry": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-retry/-/plugin-retry-6.0.1.tgz", - "integrity": "sha512-SKs+Tz9oj0g4p28qkZwl/topGcb0k0qPNX/i7vBKmDsjoeqnVfFUquqrE/O9oJY7+oLzdCtkiWSXLpLjvl6uog==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/request-error": "^5.0.0", - "@octokit/types": "^12.0.0", - "bottleneck": "^2.15.3" - }, - "engines": { - "node": ">= 18" - }, - "peerDependencies": { - "@octokit/core": ">=5" - } - }, - "node_modules/@octokit/plugin-retry/node_modules/@octokit/openapi-types": { - "version": "20.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", - "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", - "dev": true, - "license": "MIT" - }, - "node_modules/@octokit/plugin-retry/node_modules/@octokit/types": { - "version": "12.6.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", - "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/openapi-types": "^20.0.0" - } - }, - "node_modules/@octokit/request": { - "version": "8.4.0", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-8.4.0.tgz", - "integrity": "sha512-9Bb014e+m2TgBeEJGEbdplMVWwPmL1FPtggHQRkV+WVsMggPtEkLKPlcVYm/o8xKLkpJ7B+6N8WfQMtDLX2Dpw==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/endpoint": "^9.0.1", - "@octokit/request-error": "^5.1.0", - "@octokit/types": "^13.1.0", - "universal-user-agent": "^6.0.0" - }, - "engines": { - "node": ">= 18" - } - }, - "node_modules/@octokit/request-error": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.1.0.tgz", - "integrity": "sha512-GETXfE05J0+7H2STzekpKObFe765O5dlAKUTLNGeH+x47z7JjXHfsHKo5z21D/o/IOZTUEI6nyWyR+bZVP/n5Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/types": "^13.1.0", - "deprecation": "^2.0.0", - "once": "^1.4.0" - }, - "engines": { - "node": ">= 18" - } - }, - "node_modules/@octokit/types": { - "version": "13.6.1", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.6.1.tgz", - "integrity": "sha512-PHZE9Z+kWXb23Ndik8MKPirBPziOc0D2/3KH1P+6jK5nGWe96kadZuE4jev2/Jq7FvIfTlT2Ltg8Fv2x1v0a5g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/openapi-types": "^22.2.0" - } - }, - "node_modules/@octokit/webhooks-types": { - "version": "7.6.1", - "resolved": "https://registry.npmjs.org/@octokit/webhooks-types/-/webhooks-types-7.6.1.tgz", - "integrity": "sha512-S8u2cJzklBC0FgTwWVLaM8tMrDuDMVE4xiTK4EYXM9GntyvrdbSoxqDQa+Fh57CCNApyIpyeqPhhFEmHPfrXgw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@types/github-script": { - "name": "github-script", - "version": "7.0.1", - "resolved": "git+ssh://git@github.com/actions/github-script.git#660ec11d825b714d112a6bb9727086bc2cc500b2", - "dev": true, - "license": "MIT", - "dependencies": { - "@actions/core": "^1.10.1", - "@actions/exec": "^1.1.1", - "@actions/github": "^6.0.0", - "@actions/glob": "^0.4.0", - "@actions/io": "^1.1.3", - "@octokit/core": "^5.0.1", - "@octokit/plugin-request-log": "^4.0.0", - "@octokit/plugin-retry": "^6.0.1", - "@types/node": "^20.9.0" - }, - "engines": { - "node": ">=20.0.0 <21.0.0" - } - }, - "node_modules/@types/node": { - "version": "20.17.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.3.tgz", - "integrity": "sha512-tSQrmKKatLDGnG92h40GD7FzUt0MjahaHwOME4VAFeeA/Xopayq5qLyQRy7Jg/pjgKIFBXuKcGhJo+UdYG55jQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "undici-types": "~6.19.2" - } - }, - "node_modules/balanced-match": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true, - "license": "MIT" - }, - "node_modules/before-after-hook": { - "version": "2.2.3", - "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.3.tgz", - "integrity": "sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ==", - "dev": true, - "license": "Apache-2.0" - }, - "node_modules/bottleneck": { - "version": "2.19.5", - "resolved": "https://registry.npmjs.org/bottleneck/-/bottleneck-2.19.5.tgz", - "integrity": "sha512-VHiNCbI1lKdl44tGrhNfU3lup0Tj/ZBMJB5/2ZbNXRCPuRCO7ed2mgcK4r17y+KB2EfuYuRaVlwNbAeaWGSpbw==", - "dev": true, - "license": "MIT" - }, - "node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dev": true, - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/concat-map": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", - "dev": true, - "license": "MIT" - }, - "node_modules/deprecation": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", - "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "license": "ISC", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, - "node_modules/once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", - "dev": true, - "license": "ISC", - "dependencies": { - "wrappy": "1" - } - }, - "node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", - "dev": true, - "license": "MIT", - "bin": { - "prettier": "bin/prettier.cjs" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/prettier/prettier?sponsor=1" - } - }, - "node_modules/tunnel": { - "version": "0.0.6", - "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", - "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.6.11 <=0.7.0 || >=0.7.3" - } - }, - "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@fastify/busboy": "^2.0.0" - }, - "engines": { - "node": ">=14.0" - } - }, - "node_modules/undici-types": { - "version": "6.19.8", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", - "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", - "dev": true, - "license": "MIT" - }, - "node_modules/universal-user-agent": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.1.tgz", - "integrity": "sha512-yCzhz6FN2wU1NiiQRogkTQszlQSlpWaw8SvVegAc+bDxbzHgh1vX8uIe8OYyMH6DwH+sdTJsgMl36+mSMdRJIQ==", - "dev": true, - "license": "ISC" - }, - "node_modules/wrappy": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", - "dev": true, - "license": "ISC" - } - } -} diff --git a/.gitignore b/.gitignore index b07c3b3ae14e..8df07769a444 100644 --- a/.gitignore +++ b/.gitignore @@ -132,10 +132,9 @@ eng/tools/**/dist # TypeScript cache *.tsbuildinfo -# No package-lock.json files should be commited except the top-level and .github +# No package-lock.json files should be commited except the top-level. **/package-lock.json !/package-lock.json -!/.github/package-lock.json # No Armstrong outputs should be commited except the tf files. **/terraform/**/*.json From 175d71800b942faaa4113416d5e395b8ba19ce31 Mon Sep 17 00:00:00 2001 From: Younjin Song Date: Tue, 21 Jan 2025 19:47:13 -0500 Subject: [PATCH 13/74] Add 2024-10-01 stable to Microsoft.Dashboard (#31598) * Copy files from preview/2023-10-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-10-01 Updated the API version from preview/2023-10-01-preview to stable/2024-10-01. * Added tag for 2024-10-01 in readme file * changes for 2024-10-01 --------- Co-authored-by: Younjin Song --- .../examples/EnterpriseDetails_Post.json | 30 + .../2024-10-01/examples/Grafana_Create.json | 203 ++ .../2024-10-01/examples/Grafana_Delete.json | 17 + .../Grafana_FetchAvailablePlugins.json | 24 + .../2024-10-01/examples/Grafana_Get.json | 83 + .../2024-10-01/examples/Grafana_List.json | 78 + .../examples/Grafana_ListByResourceGroup.json | 78 + .../2024-10-01/examples/Grafana_Update.json | 195 ++ .../examples/IntegrationFabrics_Create.json | 59 + .../examples/IntegrationFabrics_Delete.json | 17 + .../examples/IntegrationFabrics_Get.json | 28 + .../examples/IntegrationFabrics_List.json | 46 + .../examples/IntegrationFabrics_Update.json | 45 + .../ManagedPrivateEndpoints_Create.json | 78 + .../ManagedPrivateEndpoints_Delete.json | 18 + .../examples/ManagedPrivateEndpoints_Get.json | 40 + .../ManagedPrivateEndpoints_List.json | 56 + .../ManagedPrivateEndpoints_Patch.json | 73 + .../ManagedPrivateEndpoints_Refresh.json | 16 + .../2024-10-01/examples/Operations_List.json | 25 + .../PrivateEndpointConnections_Approve.json | 43 + .../PrivateEndpointConnections_Delete.json | 17 + .../PrivateEndpointConnections_Get.json | 32 + .../PrivateEndpointConnections_List.json | 36 + .../examples/PrivateLinkResources_Get.json | 27 + .../examples/PrivateLinkResources_List.json | 31 + .../stable/2024-10-01/grafana.json | 2434 +++++++++++++++++ .../dashboard/resource-manager/readme.md | 11 +- 28 files changed, 3839 insertions(+), 1 deletion(-) create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/EnterpriseDetails_Post.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Create.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Delete.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_FetchAvailablePlugins.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Get.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_List.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_ListByResourceGroup.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Update.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Create.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Delete.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Get.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_List.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Update.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Create.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Delete.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Get.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_List.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Patch.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Refresh.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Operations_List.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Approve.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Delete.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Get.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_List.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_Get.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_List.json create mode 100644 specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/grafana.json diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/EnterpriseDetails_Post.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/EnterpriseDetails_Post.json new file mode 100644 index 000000000000..98f5a8f95168 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/EnterpriseDetails_Post.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "saasSubscriptionDetails": { + "planId": "amg_globalplan", + "offerId": "amg_test", + "publisherId": "isvtestuklegacy", + "term": { + "termUnit": "P1M", + "startDate": "2022-10-04T00:00:00Z", + "endDate": "2022-11-03T00:00:00Z" + } + }, + "marketplaceTrialQuota": { + "availablePromotion": "None", + "grafanaResourceId": "/subscriptions/e1e3b30d-e7ec-4e25-8587-db037bcb9a4d/resourcegroups/amg-local-script-test-rg/providers/microsoft.dashboard/grafana/eus2-enterprise-1001-07", + "trialStartAt": "2022-10-04T01:06:00.447Z", + "trialEndAt": "2022-11-03T01:06:00.447Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Create.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Create.json new file mode 100644 index 000000000000..56721d690e6e --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Create.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "requestBodyParameters": { + "sku": { + "name": "Standard" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "password": "", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": {} + }, + "grafanaMajorVersion": "9" + }, + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "outboundIPs": [ + "192.168.0.1", + "192.168.0.2" + ], + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": { + "pluginId": "sample-plugin-id" + } + }, + "grafanaMajorVersion": "9" + }, + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "grafanaMajorVersion": "9" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Delete.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Delete.json new file mode 100644 index 000000000000..ba826286a526 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + } + }, + "204": {} + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_FetchAvailablePlugins.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_FetchAvailablePlugins.json new file mode 100644 index 000000000000..6b11c29ae486 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_FetchAvailablePlugins.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Plugin A", + "pluginId": "plugin-a" + }, + { + "name": "Plugin B", + "pluginId": "plugin-b" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Get.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Get.json new file mode 100644 index 000000000000..ac2fcf1a19e1 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Get.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "outboundIPs": [ + "192.168.0.1", + "192.168.0.2" + ], + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": { + "pluginId": "sample-plugin-id" + } + }, + "grafanaMajorVersion": "9" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_List.json new file mode 100644 index 000000000000..8eb88271bc77 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_List.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "outboundIPs": [ + "192.168.0.1", + "192.168.0.2" + ], + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": { + "pluginId": "sample-plugin-id" + } + }, + "grafanaMajorVersion": "9" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_ListByResourceGroup.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_ListByResourceGroup.json new file mode 100644 index 000000000000..8eb88271bc77 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "outboundIPs": [ + "192.168.0.1", + "192.168.0.2" + ], + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": { + "pluginId": "sample-plugin-id" + } + }, + "grafanaMajorVersion": "9" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Update.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Update.json new file mode 100644 index 000000000000..8371a3164b00 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Grafana_Update.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "requestBodyParameters": { + "tags": { + "Environment": "Dev 2" + }, + "sku": { + "name": "Standard" + }, + "properties": { + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "password": "", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": {} + }, + "grafanaMajorVersion": "9" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "outboundIPs": [ + "192.168.0.1", + "192.168.0.2" + ], + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": { + "pluginId": "sample-plugin-id" + } + }, + "grafanaMajorVersion": "9" + }, + "tags": { + "Environment": "Dev 2" + }, + "location": "West US" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "grafanaVersion": "9.4.5", + "endpoint": "https://myworkspace-abcdefghijklmnop.wus.grafana.azure.com", + "zoneRedundancy": "Enabled", + "apiKey": "Enabled", + "deterministicOutboundIP": "Enabled", + "publicNetworkAccess": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "grafanaConfigurations": { + "smtp": { + "enabled": true, + "host": "smtp.sendemail.com:587", + "user": "username", + "fromAddress": "test@sendemail.com", + "fromName": "emailsender", + "startTLSPolicy": "OpportunisticStartTLS", + "skipVerify": true + }, + "snapshots": { + "externalEnabled": true + }, + "users": { + "viewersCanEdit": true + }, + "security": { + "csrfAlwaysCheck": false + } + }, + "grafanaIntegrations": { + "azureMonitorWorkspaceIntegrations": [ + { + "azureMonitorWorkspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.monitor/accounts/myAzureMonitorWorkspace" + } + ] + }, + "enterpriseConfigurations": { + "marketplacePlanId": "myPlanId", + "marketplaceAutoRenew": "Enabled" + }, + "grafanaPlugins": { + "sample-plugin-id": { + "pluginId": "sample-plugin-id" + } + }, + "grafanaMajorVersion": "9" + }, + "tags": { + "Environment": "Dev 2" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Create.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Create.json new file mode 100644 index 000000000000..e87aeafa0fcf --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Create.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "integrationFabricName": "sampleIntegration", + "requestBodyParameters": { + "properties": { + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw", + "scenarios": [ + "scenario1", + "scenario2" + ] + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace/integrationFabrics/myIntegrationFabricName", + "name": "sampleIntegration", + "type": "Microsoft.Dashboard/grafana/integrationFabrics", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw", + "scenarios": [ + "scenario1", + "scenario2" + ] + }, + "location": "West US" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace/integrationFabrics/myIntegrationFabricName", + "name": "sampleIntegration", + "type": "Microsoft.Dashboard/grafana/integrationFabrics", + "properties": { + "provisioningState": "Accepted", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw", + "scenarios": [ + "scenario1", + "scenario2" + ] + }, + "location": "West US" + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Delete.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Delete.json new file mode 100644 index 000000000000..7535d5863fd8 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "integrationFabricName": "sampleIntegration" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + } + }, + "204": {} + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Get.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Get.json new file mode 100644 index 000000000000..5e6c4195746f --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "integrationFabricName": "sampleIntegration" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace/integrationFabrics/myIntegrationFabricName", + "name": "sampleIntegration", + "type": "Microsoft.Dashboard/grafana/integrationFabrics", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw", + "scenarios": [ + "scenario1", + "scenario2" + ] + }, + "location": "West US" + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_List.json new file mode 100644 index 000000000000..3cfa5c3dc862 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace/integrationFabrics/myIntegrationFabricName", + "name": "sampleIntegration", + "type": "Microsoft.Dashboard/grafana/integrationFabrics", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks1", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw1", + "scenarios": [ + "scenario1", + "scenario2" + ] + }, + "location": "West US" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace/integrationFabrics/myIntegrationFabricName", + "name": "sampleIntegration", + "type": "Microsoft.Dashboard/grafana/integrationFabrics", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks2", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw2", + "scenarios": [ + "scenario1", + "scenario2" + ] + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Update.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Update.json new file mode 100644 index 000000000000..66087ea81a69 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/IntegrationFabrics_Update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "integrationFabricName": "sampleIntegration", + "requestBodyParameters": { + "tags": { + "Environment": "Dev 2" + }, + "properties": { + "scenarios": [ + "scenario1" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Dashboard/grafana/myWorkspace/integrationFabrics/myIntegrationFabricName", + "name": "sampleIntegration", + "type": "Microsoft.Dashboard/grafana/integrationFabrics", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myAks", + "dataSourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAmw", + "scenarios": [ + "scenario1" + ] + }, + "location": "West US", + "tags": { + "Environment": "Dev 2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Create.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Create.json new file mode 100644 index 000000000000..0826f2bc2f7a --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Create.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "managedPrivateEndpointName": "myMPEName", + "requestBodyParameters": { + "properties": { + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "privateLinkServiceUrl": "my-self-hosted-influxdb.westus.mydomain.com" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName", + "name": "myMPEName", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "privateLinkServiceUrl": "my-self-hosted-influxdb.westus.mydomain.com" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName", + "name": "myMPEName", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Accepted", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "privateLinkServiceUrl": "my-self-hosted-influxdb.westus.mydomain.com" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Delete.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Delete.json new file mode 100644 index 000000000000..324b134dd30a --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "managedPrivateEndpointName": "myMPEName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + } + }, + "204": {} + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Get.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Get.json new file mode 100644 index 000000000000..cb359ed34a9a --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "managedPrivateEndpointName": "myMPEName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName", + "name": "myMPEName", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "connectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_List.json new file mode 100644 index 000000000000..a5a48b197ee0 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName", + "name": "myMPEName", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource1", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "connectionState": { + "status": "Approved", + "description": "Auto-Approved" + }, + "privateLinkServiceUrl": "my-self-hosted-influxdb.westus.mydomain.com", + "privateLinkServicePrivateIP": "10.0.0.5" + }, + "location": "West US" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName2", + "name": "myMPEName2", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource2", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message 2", + "connectionState": { + "status": "Rejected", + "description": "Example Reject Reason" + } + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Patch.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Patch.json new file mode 100644 index 000000000000..7dab7a8dac3f --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Patch.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "managedPrivateEndpointName": "myMPEName", + "requestBodyParameters": { + "tags": { + "Environment": "Dev 2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName", + "name": "myMPEName", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "privateLinkServiceUrl": "my-self-hosted-influxdb.westus.mydomain.com", + "privateLinkServicePrivateIP": "10.0.0.5" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/managedPrivateEndpoints/myPrivateEndpointName", + "name": "myMPEName", + "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoint", + "properties": { + "provisioningState": "Accepted", + "privateLinkResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-000000000000/resourceGroups/xx-rg/providers/Microsoft.Kusto/Clusters/sampleKustoResource", + "privateLinkResourceRegion": "West US", + "groupIds": [ + "grafana" + ], + "requestMessage": "Example Request Message", + "privateLinkServiceUrl": "my-self-hosted-influxdb.westus.mydomain.com", + "privateLinkServicePrivateIP": "10.0.0.5" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Refresh.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Refresh.json new file mode 100644 index 000000000000..1a1b84a4a4ae --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/ManagedPrivateEndpoints_Refresh.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Operations_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Operations_List.json new file mode 100644 index 000000000000..a5c5219ae2e5 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Dashboard/grafana/write", + "display": { + "provider": "Microsoft.Dashboard", + "resource": "grafana", + "operation": "write", + "description": "Write grafana workspace resource" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Approve.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Approve.json new file mode 100644 index 000000000000..a2b032548429 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Approve.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "privateEndpointConnectionName": "myConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "test" + } + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.Dashboard/grafana/privateEndpointConnections", + "properties": { + "provisioningState": "Accepted", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Network/privateEndpoint/myEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "test", + "actionsRequired": "None" + }, + "groupIds": [ + "grafana" + ] + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Delete.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..0ba6e0908b23 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Dashboard/locations/eastus2/operationStatuses/sample-op-status?api-version=2024-10-01" + } + }, + "204": {} + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Get.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..50ac6fb369de --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "privateEndpointConnectionName": "myConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.Dashboard/grafana/privateEndpointConnections", + "properties": { + "provisioningState": "Accepted", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Network/privateEndpoint/myEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "string", + "actionsRequired": "None" + }, + "groupIds": [ + "grafana" + ] + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_List.json new file mode 100644 index 000000000000..ed1eabb41edd --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateEndpointConnections_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.Dashboard/grafana/privateEndpointConnections", + "properties": { + "provisioningState": "Accepted", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Network/privateEndpoint/myEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "string", + "actionsRequired": "None" + }, + "groupIds": [ + "grafana" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_Get.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_Get.json new file mode 100644 index 000000000000..1fa786d6deb8 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "privateLinkResourceName": "grafana" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/privateLinkResources/grafana", + "name": "grafana", + "type": "Microsoft.Dashboard/grafana/PrivateLinkResources", + "properties": { + "groupId": "grafana", + "requiredMembers": [ + "grafana" + ], + "requiredZoneNames": [ + "grafana-test.azure.com" + ] + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_List.json new file mode 100644 index 000000000000..e88ebab60e38 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/examples/PrivateLinkResources_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/Microsoft.Dashboard/grafana/myWorkspace/privateLinkResources/grafana", + "name": "grafana", + "type": "Microsoft.Dashboard/grafana/PrivateLinkResources", + "properties": { + "groupId": "grafana", + "requiredMembers": [ + "grafana" + ], + "requiredZoneNames": [ + "grafana-test.azure.com" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/grafana.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/grafana.json new file mode 100644 index 000000000000..fbc71bd7287f --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/stable/2024-10-01/grafana.json @@ -0,0 +1,2434 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Dashboard", + "description": "The Microsoft.Dashboard Rest API spec.", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Dashboard/operations": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "List all available API operations provided by Microsoft.Dashboard.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return all available API operations provided by Microsoft.Dashboard.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "List all resources of workspaces for Grafana under the specified subscription.", + "operationId": "Grafana_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return all resources of workspaces for Grafana under the specified subscription.", + "schema": { + "$ref": "#/definitions/ManagedGrafanaListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Grafana_List": { + "$ref": "./examples/Grafana_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "List all resources of workspaces for Grafana under the specified resource group.", + "operationId": "Grafana_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return all resources of workspaces for Grafana under the given resource group.", + "schema": { + "$ref": "#/definitions/ManagedGrafanaListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Grafana_ListByResourceGroup": { + "$ref": "./examples/Grafana_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "Get the properties of a specific workspace for Grafana resource.", + "operationId": "Grafana_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the properties of the required workspace for Grafana resource.", + "schema": { + "$ref": "#/definitions/ManagedGrafana" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Grafana_Get": { + "$ref": "./examples/Grafana_Get.json" + } + } + }, + "put": { + "tags": [ + "GrafanaResource" + ], + "summary": "Create or update a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.", + "operationId": "Grafana_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedGrafana" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully create a workspace for Grafana resource.", + "schema": { + "$ref": "#/definitions/ManagedGrafana" + } + }, + "201": { + "description": "Creation started. The operation was successfully started and will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedGrafana" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Grafana_Create": { + "$ref": "./examples/Grafana_Create.json" + } + } + }, + "patch": { + "tags": [ + "GrafanaResource" + ], + "summary": "Update a workspace for Grafana resource.", + "operationId": "Grafana_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedGrafanaUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully update the workspace for Grafana resource.", + "schema": { + "$ref": "#/definitions/ManagedGrafana" + } + }, + "202": { + "description": "Accepted. The operation was successfully started and will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedGrafana" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Grafana_Update": { + "$ref": "./examples/Grafana_Update.json" + } + } + }, + "delete": { + "tags": [ + "GrafanaResource" + ], + "summary": "Delete a workspace for Grafana resource.", + "operationId": "Grafana_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The workspace for Grafana resource is deleted." + }, + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content. The resource is not present or was already deleted." + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Grafana_Delete": { + "$ref": "./examples/Grafana_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Get private endpoint connections.", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the list of the private endpoint connections for Grafana resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Manual approve private endpoint connection", + "operationId": "PrivateEndpointConnections_Approve", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "Creation started. The operation was successfully started and will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Approve": { + "$ref": "./examples/PrivateEndpointConnections_Approve.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Delete private endpoint connection", + "operationId": "PrivateEndpointConnections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content. The resource is not present or was already deleted." + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "summary": "Get private endpoint connection", + "operationId": "PrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the list of the private endpoint connections for Grafana resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/PrivateEndpointConnections_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "summary": "List all private link resources information for this grafana resource", + "operationId": "PrivateLinkResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the list of the private link resources for Grafana resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/PrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "summary": "Get specific private link resource information for this grafana resource", + "operationId": "PrivateLinkResources_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "path", + "name": "privateLinkResourceName", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. Return the properties of the required private link resource for Grafana resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/PrivateLinkResources_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/checkEnterpriseDetails": { + "post": { + "tags": [ + "GrafanaResource" + ], + "summary": "Retrieve enterprise add-on details information", + "operationId": "Grafana_CheckEnterpriseDetails", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Successfully retrieve the enterprise details information of a workspace for a Grafana resource.", + "schema": { + "$ref": "#/definitions/EnterpriseDetails" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnterpriseDetails_Post": { + "$ref": "./examples/EnterpriseDetails_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/fetchAvailablePlugins": { + "post": { + "tags": [ + "GrafanaPlugin" + ], + "operationId": "Grafana_FetchAvailablePlugins", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/GrafanaAvailablePluginListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Grafana_FetchAvailablePlugins": { + "$ref": "./examples/Grafana_FetchAvailablePlugins.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints": { + "get": { + "summary": "List all managed private endpoints of a grafana resource.", + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of managed private endpoints.", + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModelListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagedPrivateEndpoint_List": { + "$ref": "./examples/ManagedPrivateEndpoints_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/refreshManagedPrivateEndpoints": { + "post": { + "summary": "Refresh and sync managed private endpoints of a grafana resource to latest state.", + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of managed private endpoints." + }, + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ManagedPrivateEndpoint_Refresh": { + "$ref": "./examples/ManagedPrivateEndpoints_Refresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}": { + "get": { + "summary": "Get a specific managed private endpoint of a grafana resource.", + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the properties of the managed private endpoint resource.", + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ManagedPrivateEndpoint_Get": { + "$ref": "./examples/ManagedPrivateEndpoints_Get.json" + } + } + }, + "put": { + "summary": "Create or update a managed private endpoint for a grafana resource.", + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "description": "The managed private endpoint to be created or updated.", + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully created a managed private endpoint for Grafana resource.", + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + }, + "201": { + "description": "Creation started. The operation was successfully started and will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "ManagedPrivateEndpoint_Create": { + "$ref": "./examples/ManagedPrivateEndpoints_Create.json" + } + } + }, + "patch": { + "summary": "Update a managed private endpoint for an existing grafana resource.", + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "description": "Properties that can be updated to an existing managed private endpoint.", + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully update the managed private endpoint for Grafana resource.", + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + }, + "202": { + "description": "Accepted. The operation was successfully started and will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ManagedPrivateEndpoints_Patch": { + "$ref": "./examples/ManagedPrivateEndpoints_Patch.json" + } + } + }, + "delete": { + "summary": "Delete a managed private endpoint for a grafana resource.", + "tags": [ + "ManagedPrivateEndpoints" + ], + "operationId": "ManagedPrivateEndpoints_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ManagedPrivateEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The managed private endpoint is deleted." + }, + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content. The resource is not present or was already deleted." + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ManagedPrivateEndpoint_Delete": { + "$ref": "./examples/ManagedPrivateEndpoints_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/integrationFabrics": { + "get": { + "tags": [ + "integrationFabric" + ], + "operationId": "IntegrationFabrics_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IntegrationFabricListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IntegrationFabrics_List": { + "$ref": "./examples/IntegrationFabrics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/integrationFabrics/{integrationFabricName}": { + "get": { + "tags": [ + "integrationFabric" + ], + "operationId": "IntegrationFabrics_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationFabricNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the properties of the integration fabric resource.", + "schema": { + "$ref": "#/definitions/IntegrationFabric" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IntegrationFabrics_Get": { + "$ref": "./examples/IntegrationFabrics_Get.json" + } + } + }, + "put": { + "tags": [ + "integrationFabric" + ], + "operationId": "IntegrationFabrics_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationFabricNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationFabric" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully created an integration fabric for Grafana resource.", + "schema": { + "$ref": "#/definitions/IntegrationFabric" + } + }, + "201": { + "description": "Creation started. The operation was successfully started and will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation URI for long running operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/IntegrationFabric" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "IntegrationFabrics_Create": { + "$ref": "./examples/IntegrationFabrics_Create.json" + } + } + }, + "patch": { + "tags": [ + "IntegrationFabric" + ], + "operationId": "IntegrationFabrics_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationFabricNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationFabricUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IntegrationFabric" + } + }, + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously.", + "headers": { + "Location": { + "description": "Operation URI for long running operation.", + "type": "string" + } + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "IntegrationFabrics_Update": { + "$ref": "./examples/IntegrationFabrics_Update.json" + } + } + }, + "delete": { + "tags": [ + "integrationFabric" + ], + "operationId": "IntegrationFabrics_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/IntegrationFabricNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously.", + "headers": { + "Location": { + "description": "Operation URI for long running operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content. The resource is not present or was already deleted." + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "IntegrationFabrics_Delete": { + "$ref": "./examples/IntegrationFabrics_Delete.json" + } + } + } + } + }, + "definitions": { + "ManagedGrafana": { + "type": "object", + "description": "The grafana resource type.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the grafana resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the grafana resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the grafana resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The Sku of the grafana resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties specific to the grafana resource.", + "$ref": "#/definitions/ManagedGrafanaProperties" + }, + "identity": { + "description": "The managed identity of the grafana resource.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "systemData": { + "description": "The system meta data relating to this grafana resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The tags for grafana resource." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the grafana resource lives" + } + } + }, + "ManagedGrafanaListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedGrafana" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "ManagedGrafanaProperties": { + "type": "object", + "description": "Properties specific to the grafana resource.", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "grafanaVersion": { + "description": "The Grafana software version.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The endpoint of the Grafana instance.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "Indicate the state for enable or disable traffic over the public interface.", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "zoneRedundancy": { + "description": "The zone redundancy setting of the Grafana instance.", + "$ref": "#/definitions/ZoneRedundancy" + }, + "apiKey": { + "description": "The api key setting of the Grafana instance.", + "$ref": "#/definitions/ApiKey" + }, + "deterministicOutboundIP": { + "description": "Whether a Grafana instance uses deterministic outbound IPs.", + "$ref": "#/definitions/DeterministicOutboundIP" + }, + "outboundIPs": { + "description": "List of outbound IPs if deterministicOutboundIP is enabled.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpointConnections": { + "description": "The private endpoint connections of the Grafana instance.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Scope for dns deterministic name hash calculation.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + }, + "grafanaIntegrations": { + "$ref": "#/definitions/GrafanaIntegrations" + }, + "enterpriseConfigurations": { + "$ref": "#/definitions/EnterpriseConfigurations" + }, + "grafanaConfigurations": { + "$ref": "#/definitions/GrafanaConfigurations" + }, + "grafanaPlugins": { + "description": "Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/GrafanaPlugin" + } + }, + "grafanaMajorVersion": { + "description": "The major Grafana software version to target.", + "type": "string" + } + } + }, + "ManagedGrafanaUpdateParameters": { + "type": "object", + "description": "The parameters for a PATCH request to a grafana resource.", + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "identity": { + "description": "The managed identity of the grafana resource.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "tags": { + "type": "object", + "description": "The new tags of the grafana resource.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "Properties specific to the managed grafana resource.", + "$ref": "#/definitions/ManagedGrafanaPropertiesUpdateParameters" + } + } + }, + "ManagedGrafanaPropertiesUpdateParameters": { + "type": "object", + "description": "The properties parameters for a PATCH request to a grafana resource.", + "properties": { + "zoneRedundancy": { + "description": "The zone redundancy setting of the Grafana instance.", + "$ref": "#/definitions/ZoneRedundancy" + }, + "apiKey": { + "description": "The api key setting of the Grafana instance.", + "$ref": "#/definitions/ApiKey" + }, + "deterministicOutboundIP": { + "description": "Whether a Grafana instance uses deterministic outbound IPs.", + "$ref": "#/definitions/DeterministicOutboundIP" + }, + "publicNetworkAccess": { + "description": "Indicate the state for enable or disable traffic over the public interface.", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "grafanaIntegrations": { + "$ref": "#/definitions/GrafanaIntegrations" + }, + "enterpriseConfigurations": { + "$ref": "#/definitions/EnterpriseConfigurations" + }, + "grafanaConfigurations": { + "$ref": "#/definitions/GrafanaConfigurations" + }, + "grafanaPlugins": { + "type": "object", + "description": "Update of Grafana plugin. Key is plugin id, value is plugin definition. If plugin definition is null, plugin with given plugin id will be removed. Otherwise, given plugin will be installed.", + "additionalProperties": { + "$ref": "#/definitions/GrafanaPlugin" + } + }, + "grafanaMajorVersion": { + "description": "The major Grafana software version to target.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "ResourceSku": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "ZoneRedundancy": { + "enum": [ + "Disabled", + "Enabled" + ], + "default": "Disabled", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ZoneRedundancy" + } + }, + "ApiKey": { + "enum": [ + "Disabled", + "Enabled" + ], + "default": "Disabled", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ApiKey" + } + }, + "DeterministicOutboundIP": { + "enum": [ + "Disabled", + "Enabled" + ], + "default": "Disabled", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeterministicOutboundIP" + } + }, + "PublicNetworkAccess": { + "description": "Indicate the state for enable or disable traffic over the public interface.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "AutoGeneratedDomainNameLabelScope": { + "description": "Scope for dns deterministic name hash calculation", + "enum": [ + "TenantReuse" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AutoGeneratedDomainNameLabelScope" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "GrafanaConfigurations": { + "description": "Server configurations of a Grafana instance", + "type": "object", + "properties": { + "smtp": { + "$ref": "#/definitions/Smtp" + }, + "snapshots": { + "$ref": "#/definitions/Snapshots" + }, + "users": { + "$ref": "#/definitions/Users" + }, + "security": { + "$ref": "#/definitions/Security" + } + } + }, + "Smtp": { + "description": "Email server settings.\r\nhttps://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp", + "type": "object", + "properties": { + "enabled": { + "description": "Enable this to allow Grafana to send email. Default is false", + "type": "boolean", + "default": false + }, + "host": { + "description": "SMTP server hostname with port, e.g. test.email.net:587", + "type": "string" + }, + "user": { + "description": "User of SMTP auth", + "type": "string" + }, + "password": { + "description": "Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes", + "type": "string", + "x-ms-secret": true + }, + "fromAddress": { + "description": "Address used when sending out emails\r\nhttps://pkg.go.dev/net/mail#Address", + "type": "string" + }, + "fromName": { + "description": "Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\"\r\nhttps://pkg.go.dev/net/mail#Address", + "type": "string" + }, + "startTLSPolicy": { + "$ref": "#/definitions/StartTLSPolicy" + }, + "skipVerify": { + "description": "Verify SSL for SMTP server. Default is false\r\nhttps://pkg.go.dev/crypto/tls#Config", + "type": "boolean" + } + } + }, + "Snapshots": { + "description": "Grafana Snapshots settings", + "type": "object", + "properties": { + "externalEnabled": { + "description": "Set to false to disable external snapshot publish endpoint", + "type": "boolean" + } + } + }, + "Users": { + "description": "Grafana users settings", + "type": "object", + "properties": { + "viewersCanEdit": { + "description": "Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes.", + "type": "boolean" + } + } + }, + "Security": { + "description": "Grafana security settings", + "type": "object", + "properties": { + "csrfAlwaysCheck": { + "description": "Set to true to execute the CSRF check even if the login cookie is not in a request (default false).", + "type": "boolean" + } + } + }, + "StartTLSPolicy": { + "description": "The StartTLSPolicy setting of the SMTP configuration\r\nhttps://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy", + "enum": [ + "OpportunisticStartTLS", + "MandatoryStartTLS", + "NoStartTLS" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StartTLSPolicy" + } + }, + "GrafanaIntegrations": { + "description": "GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.", + "type": "object", + "properties": { + "azureMonitorWorkspaceIntegrations": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/AzureMonitorWorkspaceIntegration" + } + } + } + }, + "AzureMonitorWorkspaceIntegration": { + "description": "Integrations for Azure Monitor Workspace.", + "type": "object", + "properties": { + "azureMonitorWorkspaceResourceId": { + "description": "The resource Id of the connected Azure Monitor Workspace.", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private endpoint connection group ids." + }, + "provisioningState": { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "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": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "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." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "A list of private link resources" + }, + "EnterpriseConfigurations": { + "description": "Enterprise settings of a Grafana instance", + "type": "object", + "properties": { + "marketplacePlanId": { + "description": "The Plan Id of the Azure Marketplace subscription for the Enterprise plugins", + "type": "string" + }, + "marketplaceAutoRenew": { + "$ref": "#/definitions/MarketplaceAutoRenew" + } + } + }, + "MarketplaceAutoRenew": { + "description": "The AutoRenew setting of the Enterprise subscription", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MarketplaceAutoRenew" + } + }, + "EnterpriseDetails": { + "description": "Enterprise details of a Grafana instance", + "type": "object", + "properties": { + "saasSubscriptionDetails": { + "$ref": "#/definitions/SaasSubscriptionDetails" + }, + "marketplaceTrialQuota": { + "$ref": "#/definitions/MarketplaceTrialQuota" + } + } + }, + "GrafanaPlugin": { + "description": "Plugin of Grafana", + "type": "object", + "properties": { + "pluginId": { + "description": "Grafana plugin id", + "type": "string", + "readOnly": true + } + } + }, + "GrafanaAvailablePlugin": { + "description": "Available plugins of grafana", + "type": "object", + "properties": { + "pluginId": { + "description": "Grafana plugin id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Grafana plugin display name", + "type": "string", + "readOnly": true + } + } + }, + "GrafanaAvailablePluginListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GrafanaAvailablePlugin" + }, + "x-ms-identifiers": [ + "pluginId" + ] + }, + "nextLink": { + "type": "string" + } + } + }, + "SaasSubscriptionDetails": { + "description": "SaaS subscription details of a Grafana instance", + "type": "object", + "properties": { + "planId": { + "description": "The plan Id of the SaaS subscription.", + "type": "string" + }, + "offerId": { + "description": "The offer Id of the SaaS subscription.", + "type": "string" + }, + "publisherId": { + "description": "The publisher Id of the SaaS subscription.", + "type": "string" + }, + "term": { + "description": "The billing term of the SaaS Subscription.", + "$ref": "#/definitions/SubscriptionTerm" + } + } + }, + "SubscriptionTerm": { + "description": "The current billing term of the SaaS Subscription.", + "type": "object", + "properties": { + "termUnit": { + "description": "The unit of the billing term.", + "type": "string" + }, + "startDate": { + "description": "The date and time in UTC of when the billing term starts.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The date and time in UTC of when the billing term ends.", + "type": "string", + "format": "date-time" + } + } + }, + "MarketplaceTrialQuota": { + "description": "The allocation details of the per subscription free trial slot of the subscription.", + "type": "object", + "properties": { + "availablePromotion": { + "description": "Available enterprise promotion for the subscription", + "$ref": "#/definitions/AvailablePromotion" + }, + "grafanaResourceId": { + "description": "Resource Id of the Grafana resource which is doing the trial.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Dashboard/grafana" + } + ] + } + }, + "trialStartAt": { + "description": "The date and time in UTC of when the trial starts.", + "type": "string", + "format": "date-time" + }, + "trialEndAt": { + "description": "The date and time in UTC of when the trial ends.", + "type": "string", + "format": "date-time" + } + } + }, + "AvailablePromotion": { + "enum": [ + "None", + "FreeTrial" + ], + "type": "string", + "default": "None", + "x-ms-enum": { + "modelAsString": true, + "name": "AvailablePromotion" + } + }, + "ManagedPrivateEndpointModel": { + "type": "object", + "description": "The managed private endpoint resource type.", + "x-ms-azure-resource": true, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Resource properties.", + "$ref": "#/definitions/ManagedPrivateEndpointModelProperties" + } + } + }, + "ManagedPrivateEndpointModelProperties": { + "type": "object", + "description": "Properties specific to the managed private endpoint.", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "privateLinkResourceId": { + "description": "The ARM resource ID of the resource for which the managed private endpoint is pointing to.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateLinkResourceRegion": { + "description": "The region of the resource to which the managed private endpoint is pointing to.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "groupIds": { + "description": "The group Ids of the managed private endpoint.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "requestMessage": { + "description": "User input request message of the managed private endpoint.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "connectionState": { + "$ref": "#/definitions/ManagedPrivateEndpointConnectionState", + "readOnly": true + }, + "privateLinkServiceUrl": { + "description": "The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "privateLinkServicePrivateIP": { + "description": "The private IP of private endpoint after approval. This property is empty before connection is approved.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedPrivateEndpointModelListResponse": { + "description": "The list of managed private endpoints of a grafana resource", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedPrivateEndpointModel" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "ManagedPrivateEndpointConnectionState": { + "description": "The state of managed private endpoint connection.", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/ManagedPrivateEndpointConnectionStatus", + "readOnly": true + }, + "description": { + "description": "Gets or sets the reason for approval/rejection of the connection.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedPrivateEndpointConnectionStatus": { + "description": "The approval/rejection status of managed private endpoint connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedPrivateEndpointConnectionStatus" + } + }, + "ManagedPrivateEndpointUpdateParameters": { + "description": "The parameters for a PATCH request to a managed private endpoint.", + "type": "object", + "properties": { + "tags": { + "description": "The new tags of the managed private endpoint.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IntegrationFabric": { + "type": "object", + "description": "The integration fabric resource type.", + "x-ms-azure-resource": true, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IntegrationFabricProperties" + } + } + }, + "IntegrationFabricListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IntegrationFabric" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "IntegrationFabricProperties": { + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "targetResourceId": { + "description": "The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster.", + "type": "string", + "format": "arm-id" + }, + "dataSourceResourceId": { + "description": "The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc.", + "type": "string", + "format": "arm-id" + }, + "scenarios": { + "description": "A list of integration scenarios covered by this integration fabric", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IntegrationFabricUpdateParameters": { + "description": "The parameters for a PATCH request to a Integration Fabric resource.", + "type": "object", + "properties": { + "tags": { + "description": "The new tags of the Integration Fabric resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "The new properties of this Integration Fabric resource", + "$ref": "#/definitions/IntegrationFabricPropertiesUpdateParameters" + } + } + }, + "IntegrationFabricPropertiesUpdateParameters": { + "type": "object", + "properties": { + "scenarios": { + "description": "The new integration scenarios covered by this integration fabric.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "parameters": { + "WorkspaceNameParameter": { + "in": "path", + "name": "workspaceName", + "description": "The workspace name of Azure Managed Grafana.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "The private endpoint connection name of Azure Managed Grafana.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedPrivateEndpointNameParameter": { + "in": "path", + "name": "managedPrivateEndpointName", + "description": "The managed private endpoint name of Azure Managed Grafana.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IntegrationFabricNameParameter": { + "in": "path", + "name": "integrationFabricName", + "description": "The integration fabric name of Azure Managed Grafana.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-z0-9A-Z-]{0,18}[a-z0-9A-Z]$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dashboard/resource-manager/readme.md b/specification/dashboard/resource-manager/readme.md index 2f6d643653b0..e43a7b37dbcc 100644 --- a/specification/dashboard/resource-manager/readme.md +++ b/specification/dashboard/resource-manager/readme.md @@ -28,10 +28,19 @@ These are the global settings for the Dashboard API. title: DashboardManagementClient openapi-type: arm openapi-subtype: rpaas -tag: package-2023-10-01-preview +tag: package-2024-10-01 ``` +### Tag: package-2024-10-01 + +These settings apply only when `--tag=package-2024-10-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-10-01' +input-file: + - Microsoft.Dashboard/stable/2024-10-01/grafana.json +``` + ### Tag: package-2023-10-01-preview These settings apply only when `--tag=package-2023-10-01-preview` is specified on the command line. From 63685369d3d7bdee95c51fb111c410c2cb5be8ec Mon Sep 17 00:00:00 2001 From: Xiaofei Cao <92354331+XiaofeiCao@users.noreply.github.com> Date: Wed, 22 Jan 2025 12:23:37 +0800 Subject: [PATCH 14/74] java, tspconfig for computeschedule (#32264) * java config * package-dir --- .../computeschedule/ComputeSchedule.Management/client.tsp | 5 +++++ .../ComputeSchedule.Management/tspconfig.yaml | 1 - 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/computeschedule/ComputeSchedule.Management/client.tsp b/specification/computeschedule/ComputeSchedule.Management/client.tsp index a235c1db02fa..d35b22a9778a 100644 --- a/specification/computeschedule/ComputeSchedule.Management/client.tsp +++ b/specification/computeschedule/ComputeSchedule.Management/client.tsp @@ -5,6 +5,11 @@ using Azure.ClientGenerator.Core; using Microsoft.ComputeSchedule; @@clientName(Microsoft.ComputeSchedule, "ComputeScheduleMgmt", "python"); +@@clientName(Microsoft.ComputeSchedule, "ComputeScheduleMgmtClient", "java"); +@@clientNamespace(Microsoft.ComputeSchedule, + "com.azure.resourcemanager.computeschedule", + "java" +); @@clientName(ScheduledActions.virtualMachinesSubmitDeallocate, "SubmitVirtualMachineDeallocate", diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index 2b59f7037aa0..156adb5dde26 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -34,7 +34,6 @@ options: "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-computeschedule" flavor: "azure" - namespace: "com.azure.resourcemanager.computeschedule" service-name: "Compute Schedule" linter: extends: From 16eba0e39fedb21b9a7a3df5bec5524c78c72ba3 Mon Sep 17 00:00:00 2001 From: Chenjie Shi Date: Wed, 22 Jan 2025 14:25:16 +0800 Subject: [PATCH 15/74] Backward compatibility for service networking (#32247) * Backward compatibility for service networking * fix lint * fix flatten * flatten workaround * add suppression * fix doc * format --- .../ServiceNetworking.Management/main.tsp | 34 +++++++++++++++---- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/specification/servicenetworking/ServiceNetworking.Management/main.tsp b/specification/servicenetworking/ServiceNetworking.Management/main.tsp index 9c420b15e4a1..1d358a7928cb 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/main.tsp +++ b/specification/servicenetworking/ServiceNetworking.Management/main.tsp @@ -69,6 +69,32 @@ model Association is TrackedResource { name: string; } +/** The type used for update operations of the Association. */ +model AssociationUpdate { + /** Resource tags. */ + tags?: TrackedResource.tags; + + /** The resource-specific properties for this resource. */ + #suppress "@azure-tools/typespec-azure-core/no-private-usage" + @Azure.ResourceManager.Private.conditionalClientFlatten + properties?: AssociationUpdateProperties; +} + +/** The updatable properties of the Association. */ +model AssociationUpdateProperties { + /** Association Type */ + associationType?: AssociationType; + + /** Association Subnet */ + subnet?: AssociationSubnetUpdate; +} + +/** Association Subnet. */ +model AssociationSubnetUpdate { + /** Association ID. */ + id: string; +} + /** Association Properties. */ model AssociationProperties { /** Association Type */ @@ -232,13 +258,7 @@ interface AssociationsInterface { Association, LroHeaders = Azure.Core.Foundations.RetryAfterHeader >; - update is ArmCustomPatchSync< - Association, - Azure.ResourceManager.Foundations.ResourceUpdateModel< - Association, - AssociationProperties - > - >; + update is ArmCustomPatchSync; delete is ArmResourceDeleteWithoutOkAsync; listByTrafficController is ArmResourceListByParent; } From cca1cce47c2eba7ba0870d3d1f757231be187cc7 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:56:11 +0800 Subject: [PATCH 16/74] Update tspconfig.yaml (#32268) --- .../liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml index a40e43eb2b03..2025a5b9e0e7 100644 --- a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml +++ b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml @@ -29,6 +29,7 @@ options: packageDetails: name: "@azure/arm-pineconevectordb" "@azure-tools/typespec-python": + service-dir: "sdk/pineconevectordb" package-dir: "azure-mgmt-pineconevectordb" package-name: "{package-dir}" flavor: "azure" From 5f84fd4cb51170b038e4f3987970ed1aecc55ab2 Mon Sep 17 00:00:00 2001 From: Xinni Tong Date: Wed, 22 Jan 2025 15:57:32 +0800 Subject: [PATCH 17/74] Bump openapi-to-typespec to 0.10.8 (#32267) --- package-lock.json | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package-lock.json b/package-lock.json index 38713b8f0160..f1ffe4f00aa3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,7 @@ "": { "name": "azure-rest-api-specs", "devDependencies": { - "@autorest/openapi-to-typespec": "0.10.7", + "@autorest/openapi-to-typespec": "0.10.8", "@azure-tools/typespec-apiview": "0.5.0", "@azure-tools/typespec-autorest": "0.50.0", "@azure-tools/typespec-azure-core": "0.50.0", @@ -510,9 +510,9 @@ } }, "node_modules/@autorest/openapi-to-typespec": { - "version": "0.10.7", - "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.7.tgz", - "integrity": "sha512-hOrZR5dazZjQiBO90MSi6N4PImHmi4zz8/ft+LqlUDISdiG4PlxlSh+KP5NL2Cq2PJ/It+9BlSXknlz2lM4/2Q==", + "version": "0.10.8", + "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.8.tgz", + "integrity": "sha512-/mn1DG7apiotcO2Bjiq68m4YHxZGyJXEWPBKgG5ODifRRk3QvOiEMQ7YBq4bntWVMT7tFXAUoiU4S/wgZmn3kw==", "dev": true, "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 8977be87fc4b..e44503e5efed 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "@azure-tools/typespec-client-generator-core": "0.50.0", "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", - "@autorest/openapi-to-typespec": "0.10.7", + "@autorest/openapi-to-typespec": "0.10.8", "@typespec/compiler": "0.64.0", "@typespec/http": "0.64.0", "@typespec/openapi": "0.64.0", From acd0437204d5fcd0ccfcbe09257caec0edfc198e Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 22 Jan 2025 16:41:19 +0800 Subject: [PATCH 18/74] override service-dir for java (#32271) --- .../liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml index 2025a5b9e0e7..79d0953c38b1 100644 --- a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml +++ b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml @@ -36,6 +36,7 @@ options: generate-test: true generate-sample: true "@azure-tools/typespec-java": + service-dir: "sdk/pineconevectordb" package-dir: "azure-resourcemanager-pineconevectordb" flavor: "azure" "@azure-tools/typespec-go": From 3a17b429e962d7a1a01c3c8fcdded8c8a2364196 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Wed, 22 Jan 2025 19:15:54 +0800 Subject: [PATCH 19/74] liftrpinecone, java config (#32275) --- .../liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml index 79d0953c38b1..ccdbd5478fa9 100644 --- a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml +++ b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml @@ -11,7 +11,7 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": - package-dir: "Azure.ResourceManager.PineconeVectorDB" + package-dir: "Azure.ResourceManager.PineconeVectorDb" flavor: azure clear-output-folder: true use-write-core: true @@ -39,6 +39,7 @@ options: service-dir: "sdk/pineconevectordb" package-dir: "azure-resourcemanager-pineconevectordb" flavor: "azure" + service-name: "Pinecone Vector Db" "@azure-tools/typespec-go": service-dir: "sdk/resourcemanager/pineconevectordb" package-dir: "armpineconevectordb" From a1fd6426189e0dd5129eec6aea8d9788fa02bd33 Mon Sep 17 00:00:00 2001 From: Judy Liu Date: Wed, 22 Jan 2025 21:19:13 +0800 Subject: [PATCH 20/74] add go config (#32274) --- .../ServiceNetworking.Management/tspconfig.yaml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml index 35d5cb72156e..145f8a6cc3dd 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml +++ b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml @@ -35,6 +35,16 @@ options: flavor: "azure" generate-test: true generate-sample: true + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/servicenetworking" + package-dir: "armservicenetworking" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-servicenetworking" flavor: "azure" From d8322344919f53f162e90fab01eb324b0c2eab30 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Wed, 22 Jan 2025 10:39:25 -0800 Subject: [PATCH 21/74] Sync eng/common directory with azure-sdk-tools for PR 9668 (#32277) * Support incrementing semver prereleases with 'zero' versions * Make tests more explicit --------- Co-authored-by: Patrick Hallisey --- eng/common/scripts/SemVer.ps1 | 107 ++++++++++++++++++++++++++++------ 1 file changed, 88 insertions(+), 19 deletions(-) diff --git a/eng/common/scripts/SemVer.ps1 b/eng/common/scripts/SemVer.ps1 index 6459f252a67c..689a70e778c4 100644 --- a/eng/common/scripts/SemVer.ps1 +++ b/eng/common/scripts/SemVer.ps1 @@ -78,13 +78,10 @@ class AzureEngSemanticVersion : IComparable { if ($null -eq $matches['prelabel']) { - # artifically provide these values for non-prereleases to enable easy sorting of them later than prereleases. - $this.PrereleaseLabel = "zzz" - $this.PrereleaseNumber = 99999999 $this.IsPrerelease = $false $this.VersionType = "GA" if ($this.Major -eq 0) { - # Treat initial 0 versions as a prerelease beta's + # Treat initial 0 versions as a prerelease beta's $this.VersionType = "Beta" $this.IsPrerelease = $true } @@ -116,7 +113,7 @@ class AzureEngSemanticVersion : IComparable { # See https://azure.github.io/azure-sdk/policies_releases.html#package-versioning [bool] HasValidPrereleaseLabel() { - if ($this.IsPrerelease -eq $true) { + if ($this.PrereleaseLabel) { if ($this.PrereleaseLabel -ne $this.DefaultPrereleaseLabel -and $this.PrereleaseLabel -ne $this.DefaultAlphaReleaseLabel) { Write-Host "Unexpected pre-release identifier '$($this.PrereleaseLabel)', "` "should be '$($this.DefaultPrereleaseLabel)' or '$($this.DefaultAlphaReleaseLabel)'" @@ -136,7 +133,7 @@ class AzureEngSemanticVersion : IComparable { { $versionString = "{0}.{1}.{2}" -F $this.Major, $this.Minor, $this.Patch - if ($this.IsPrerelease -and $this.PrereleaseLabel -ne "zzz") + if ($this.PrereleaseLabel) { $versionString += $this.PrereleaseLabelSeparator + $this.PrereleaseLabel + ` $this.PrereleaseNumberSeparator + $this.PrereleaseNumber @@ -147,24 +144,42 @@ class AzureEngSemanticVersion : IComparable { return $versionString; } - [void] IncrementAndSetToPrerelease() { - if ($this.IsPrerelease -eq $false) + [void] IncrementAndSetToPrerelease($Segment) { + if ($this.BuildNumber) { - $this.PrereleaseLabel = $this.DefaultPrereleaseLabel - $this.PrereleaseNumber = 1 - $this.Minor++ - $this.Patch = 0 - $this.IsPrerelease = $true + throw "Cannot increment releases tagged with azure pipelines build numbers" + } + + if ($this.PrereleaseLabel) + { + $this.PrereleaseNumber++ } else { - if ($this.BuildNumber) { - throw "Cannot increment releases tagged with azure pipelines build numbers" + $this.$Segment++ + if($Segment -eq "Major") { + $this.Minor = 0 + $this.Patch = 0 } - $this.PrereleaseNumber++ + if($Segment -eq "Minor") { + $this.Patch = 0 + } + + # If the major version is 0, we don't need a prerelease label + if ($this.Major -ne 0) + { + $this.PrereleaseLabel = $this.DefaultPrereleaseLabel + $this.PrereleaseNumber = 1 + } + + $this.IsPrerelease = $true } } + [void] IncrementAndSetToPrerelease() { + $this.IncrementAndSetToPrerelease("Minor") + } + [void] SetupPythonConventions() { # Python uses no separators and "b" for beta so this sets up the the object to work with those conventions @@ -198,11 +213,30 @@ class AzureEngSemanticVersion : IComparable { $ret = $this.Patch.CompareTo($other.Patch) if ($ret) { return $ret } + # provide artificial prerelease values for non-prereleases to sort them later than prereleases. + if ($this.PrereleaseLabel) { + $thisPrereleaseLabel = $this.PrereleaseLabel + $thisPrereleaseNumber = $this.PrereleaseNumber + } + else { + $thisPrereleaseLabel = "zzz" + $thisPrereleaseNumber = 99999999 + } + + if ($other.PrereleaseLabel) { + $otherPrereleaseLabel = $other.PrereleaseLabel + $otherPrereleaseNumber = $other.PrereleaseNumber + } + else { + $otherPrereleaseLabel = "zzz" + $otherPrereleaseNumber = 99999999 + } + # Mimic PowerShell that uses case-insensitive comparisons by default. - $ret = [string]::Compare($this.PrereleaseLabel, $other.PrereleaseLabel, $true) + $ret = [string]::Compare($thisPrereleaseLabel, $otherPrereleaseLabel, $true) if ($ret) { return $ret } - $ret = $this.PrereleaseNumber.CompareTo($other.PrereleaseNumber) + $ret = $thisPrereleaseNumber.CompareTo($otherPrereleaseNumber) if ($ret) { return $ret } return ([int] $this.BuildNumber).CompareTo([int] $other.BuildNumber) @@ -360,6 +394,41 @@ class AzureEngSemanticVersion : IComparable { Write-Host "Error: Python beta string did not correctly increment" } + $version = [AzureEngSemanticVersion]::ParseVersionString("0.1.2") + $version.IncrementAndSetToPrerelease() + $expected = "0.2.0" + if ($expected -ne $version.ToString()) { + Write-Host "Error: version string did not correctly increment. Expected: $expected, Actual: $version" + } + + $version = [AzureEngSemanticVersion]::ParseVersionString("0.1.2") + $version.IncrementAndSetToPrerelease("patch") + $expected = "0.1.3" + if ($expected -ne $version.ToString()) { + Write-Host "Error: version string did not correctly increment. Expected: $expected, Actual: $version" + } + + $version = [AzureEngSemanticVersion]::ParseVersionString("0.1.2") + $version.IncrementAndSetToPrerelease("minor") + $expected = "0.2.0" + if ($expected -ne $version.ToString()) { + Write-Host "Error: version string did not correctly increment. Expected: $expected, Actual: $version" + } + + $version = [AzureEngSemanticVersion]::ParseVersionString("0.1.2") + $version.IncrementAndSetToPrerelease("major") + $expected = "1.0.0-beta.1" + if ($expected -ne $version.ToString()) { + Write-Host "Error: version string did not correctly increment. Expected: $expected, Actual: $version" + } + + $version = [AzureEngSemanticVersion]::ParseVersionString("1.0.0-beta.1") + $version.IncrementAndSetToPrerelease() + $expected = "1.0.0-beta.2" + if ($expected -ne $version.ToString()) { + Write-Host "Error: version string did not correctly increment. Expected: $expected, Actual: $version" + } + Write-Host "QuickTests done" } -} +} \ No newline at end of file From 3f1f282459b3ad567077054d52b2193144ee7253 Mon Sep 17 00:00:00 2001 From: Josiah Vinson <88204686+jovinson-ms@users.noreply.github.com> Date: Wed, 22 Jan 2025 14:07:46 -0800 Subject: [PATCH 22/74] Adding back Deid examples (#31802) * Adding back Deid examples * formatting * adding back preview version to README --------- Co-authored-by: Josiah Vinson --- .../examples/CancelJob.json | 41 ++++++++++ .../examples/CreateJob.json | 75 +++++++++++++++++++ .../examples/Deidentify.json | 40 ++++++++++ .../examples/DeleteJob.json | 12 +++ .../2024-07-12-preview/examples/GetJob.json | 41 ++++++++++ .../examples/ListJobDocuments.json | 38 ++++++++++ .../2024-07-12-preview/examples/ListJobs.json | 47 ++++++++++++ .../readme.md | 9 +++ 8 files changed, 303 insertions(+) create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json new file mode 100644 index 000000000000..c70063471c24 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json @@ -0,0 +1,41 @@ +{ + "title": "Cancel a de-identification job.", + "operationId": "CancelJob", + "parameters": { + "api-version": "2024-07-12-preview", + "name": "documents_smith_1", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "documents_smith_1", + "sourceLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents", + "extensions": [ + "*" + ] + }, + "targetLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents" + }, + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]", + "status": "Canceled", + "lastUpdatedAt": "2024-01-26T01:15:00.009Z", + "createdAt": "2024-01-25T23:27:43.009Z", + "startedAt": "2024-01-25T23:27:43.009Z", + "summary": { + "successful": 10, + "failed": 0, + "canceled": 2, + "total": 12, + "bytesProcessed": 4096 + } + } + } + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json new file mode 100644 index 000000000000..87689147cfcf --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json @@ -0,0 +1,75 @@ +{ + "title": "Create a de-identification job.", + "operationId": "CreateJob", + "parameters": { + "api-version": "2024-07-12-preview", + "name": "documents_smith_1", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "resource": { + "sourceLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents", + "extensions": [ + "*" + ] + }, + "targetLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents" + }, + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]", + "status": "NotStarted" + } + }, + "responses": { + "200": { + "body": { + "name": "documents_smith_1", + "sourceLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents", + "extensions": [ + "*" + ] + }, + "targetLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents" + }, + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]", + "status": "NotStarted", + "lastUpdatedAt": "2024-01-26T01:15:00.009Z", + "createdAt": "2024-01-25T23:27:43.009Z" + } + }, + "201": { + "headers": { + "original-uri": "https://contoso.com/operationstatus" + }, + "body": { + "name": "documents_smith_1", + "sourceLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents", + "extensions": [ + "*" + ] + }, + "targetLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents" + }, + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]", + "status": "NotStarted", + "lastUpdatedAt": "2024-01-26T01:15:00.009Z", + "createdAt": "2024-01-25T23:27:43.009Z" + } + } + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json new file mode 100644 index 000000000000..e2021314bf20 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json @@ -0,0 +1,40 @@ +{ + "title": "De-identify text.", + "operationId": "Deidentify", + "parameters": { + "api-version": "2024-07-12-preview", + "body": { + "inputText": "Hello my name is John Smith.", + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]" + } + }, + "responses": { + "200": { + "body": { + "outputText": "Hello my name is [name].", + "taggerResult": { + "entities": [ + { + "category": "Patient", + "offset": { + "utf8": 17, + "utf16": 17, + "codePoint": 17 + }, + "length": { + "utf8": 10, + "utf16": 10, + "codePoint": 10 + }, + "text": "John Smith", + "confidenceScore": 0.83 + } + ], + "etag": "0x000000000000000" + } + } + } + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json new file mode 100644 index 000000000000..9b49028db92a --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json @@ -0,0 +1,12 @@ +{ + "title": "Delete a de-identification job.", + "operationId": "DeleteJob", + "parameters": { + "api-version": "2024-07-12-preview", + "name": "documents_smith_1", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json new file mode 100644 index 000000000000..41496ff69046 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json @@ -0,0 +1,41 @@ +{ + "title": "Get a de-identification job.", + "operationId": "GetJob", + "parameters": { + "api-version": "2024-07-12-preview", + "name": "documents_smith_1", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "documents_smith_1", + "sourceLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents", + "extensions": [ + "*" + ] + }, + "targetLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents" + }, + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]", + "status": "Succeeded", + "lastUpdatedAt": "2024-01-26T01:15:00.009Z", + "createdAt": "2024-01-25T23:27:43.009Z", + "startedAt": "2024-01-25T23:27:43.009Z", + "summary": { + "successful": 10, + "failed": 0, + "canceled": 0, + "total": 10, + "bytesProcessed": 4096 + } + } + } + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json new file mode 100644 index 000000000000..372911afab67 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json @@ -0,0 +1,38 @@ +{ + "title": "List processed documents within a job.", + "operationId": "ListJobDocuments", + "parameters": { + "api-version": "2024-07-12-preview", + "name": "documents_smith_1", + "maxpagesize": 10, + "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "00000000-0000-0000-0000-000000000000", + "input": { + "path": "/documents/patient_doc_1", + "etag": "0x8DB638EEA0CC717" + }, + "output": { + "path": "_output/documents/patient_doc_1", + "etag": "0xAB298APO23099ZL" + }, + "status": "Failed", + "error": { + "code": "FileNotFound", + "message": "File was moved after job started.", + "target": "SourceFile", + "details": [] + } + } + ], + "nextLink": "https://deidtest.api.deid.azure.com/jobs/00000000-0000-0000-0000-000000000000/files?top=10&skip=10&maxpagesize=10" + } + } + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json new file mode 100644 index 000000000000..43061dc58040 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json @@ -0,0 +1,47 @@ +{ + "title": "List de-identification jobs.", + "operationId": "ListJobs", + "parameters": { + "api-version": "2024-07-12-preview", + "maxpagesize": 10, + "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "documents_smith_1", + "sourceLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents", + "extensions": [ + "*" + ] + }, + "targetLocation": { + "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", + "prefix": "/documents" + }, + "operation": "Redact", + "dataType": "Plaintext", + "redactionFormat": "[{type}]", + "status": "Succeeded", + "lastUpdatedAt": "2024-01-26T01:15:00.009Z", + "createdAt": "2024-01-25T23:27:43.009Z", + "startedAt": "2024-01-25T23:27:43.009Z", + "summary": { + "successful": 10, + "failed": 0, + "canceled": 0, + "total": 10, + "bytesProcessed": 4096 + } + } + ], + "nextLink": "https://deidtest.api.deid.azure.com/jobs?top=10&skip=10&maxpagesize=10" + } + } + } +} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md index 883a2262edbb..4f7aec4bdb1f 100644 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md @@ -42,6 +42,15 @@ input-file: - stable/2024-11-15/HealthDataAIServices.DeidServices.json ``` +### Tag: package-2024-07-12-preview + +These settings apply only when `--tag=package-2024-07-12-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-12-preview' +input-file: + - preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json +``` + --- # Code Generation From 508a12f060dc46c5dcfabd0cd98a913b44b24e47 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:30:30 -0800 Subject: [PATCH 23/74] Sync eng/common directory with azure-sdk-tools for PR 9656 (#32286) * Added label handle sdk-gen pipeline template Added common script to delete label from a PR * Update eng/common/scripts/Invoke-GitHubAPI.ps1 Co-authored-by: Ben Broderick Phillips --------- Co-authored-by: ray chen Co-authored-by: Ben Broderick Phillips --- .../templates/jobs/archetype-spec-gen-sdk.yml | 28 ++++++++++++++++ eng/common/scripts/Invoke-GitHubAPI.ps1 | 33 +++++++++++++++++++ eng/common/scripts/Remove-IssueLabel.ps1 | 32 ++++++++++++++++++ 3 files changed, 93 insertions(+) create mode 100644 eng/common/scripts/Remove-IssueLabel.ps1 diff --git a/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml b/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml index 2eb1ca65992b..30722e8df7fb 100644 --- a/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml +++ b/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml @@ -168,6 +168,34 @@ jobs: artifactName: $(sdkArtifactName) targetPath: "$(System.DefaultWorkingDirectory)/generatedSdkArtifacts" + - task: PowerShell@2 + displayName: Add label to the spec PR + condition: and(eq(variables['Build.Reason'], 'PullRequest'), ne(variables['BreakingChangeLabel'], ''), eq(variables['BreakingChangeLabelAction'], 'add')) + inputs: + pwsh: true + workingDirectory: $(SdkRepoDirectory) + filePath: $(SdkRepoDirectory)/eng/common/scripts/Add-IssueLabels.ps1 + arguments: > + -RepoOwner $(SpecRepoOwner) + -RepoName $(SpecRepoName) + -IssueNumber "$(System.PullRequest.PullRequestNumber)" + -Labels $(BreakingChangeLabel) + -AuthToken "$(azuresdk-github-pat)" + + - task: PowerShell@2 + displayName: Remove label from the spec PR + condition: and(eq(variables['Build.Reason'], 'PullRequest'), ne(variables['BreakingChangeLabel'], ''), eq(variables['BreakingChangeLabelAction'], 'remove')) + inputs: + pwsh: true + workingDirectory: $(SdkRepoDirectory) + filePath: $(SdkRepoDirectory)/eng/common/scripts/Remove-IssueLabel.ps1 + arguments: > + -RepoOwner $(SpecRepoOwner) + -RepoName $(SpecRepoName) + -IssueNumber "$(System.PullRequest.PullRequestNumber)" + -LabelName $(BreakingChangeLabel) + -AuthToken "$(azuresdk-github-pat)" + - ${{ if eq(parameters.SkipPullRequestCreation, false) }}: - template: /eng/common/pipelines/templates/steps/git-push-changes.yml parameters: diff --git a/eng/common/scripts/Invoke-GitHubAPI.ps1 b/eng/common/scripts/Invoke-GitHubAPI.ps1 index c4a9fa5bb11e..3c7c0596dfcd 100644 --- a/eng/common/scripts/Invoke-GitHubAPI.ps1 +++ b/eng/common/scripts/Invoke-GitHubAPI.ps1 @@ -258,6 +258,39 @@ function Add-GitHubIssueComment { -MaximumRetryCount 3 } +# Will delete label from the issue if it exists +function Remove-GitHubIssueLabel { + param ( + [Parameter(Mandatory = $true)] + $RepoOwner, + [Parameter(Mandatory = $true)] + $RepoName, + [Parameter(Mandatory = $true)] + $IssueNumber, + [ValidateNotNullOrEmpty()] + [Parameter(Mandatory = $true)] + $LabelName, + [ValidateNotNullOrEmpty()] + [Parameter(Mandatory = $true)] + $AuthToken + ) + + if ($LabelName.Trim().Length -eq 0) + { + throw " The 'LabelName' parameter should not be empty or whitespace." + } + # Encode the label name + $encodedLabelName = [System.Web.HttpUtility]::UrlEncode($LabelName) + + $uri = "$GithubAPIBaseURI/$RepoOwner/$RepoName/issues/$IssueNumber/labels/$encodedLabelName" + + return Invoke-RestMethod ` + -Method DELETE ` + -Uri $uri ` + -Headers (Get-GitHubApiHeaders -token $AuthToken) ` + -MaximumRetryCount 3 +} + # Will add labels to existing labels on the issue function Add-GitHubIssueLabels { param ( diff --git a/eng/common/scripts/Remove-IssueLabel.ps1 b/eng/common/scripts/Remove-IssueLabel.ps1 new file mode 100644 index 000000000000..1af5bea443c9 --- /dev/null +++ b/eng/common/scripts/Remove-IssueLabel.ps1 @@ -0,0 +1,32 @@ +[CmdletBinding(SupportsShouldProcess = $true)] +param( + [Parameter(Mandatory = $true)] + [string]$RepoOwner, + + [Parameter(Mandatory = $true)] + [string]$RepoName, + + [Parameter(Mandatory = $true)] + [string]$IssueNumber, + + [Parameter(Mandatory = $true)] + [string]$LabelName, + + [Parameter(Mandatory = $true)] + [string]$AuthToken +) + +. (Join-Path $PSScriptRoot common.ps1) + +try { + Remove-GitHubIssueLabel -RepoOwner $RepoOwner -RepoName $RepoName ` + -IssueNumber $IssueNumber -LabelName $LabelName -AuthToken $AuthToken +} +catch { + if ($_.Exception.Response.StatusCode -eq 404) { + LogWarning "Label $LabelName not found on issue" + exit 0 + } + LogError "Remove-GithubIssueLabel failed with exception:`n$_" + exit 1 +} \ No newline at end of file From ab01320c77bb6351580e879fcfbb2ba84b068ab7 Mon Sep 17 00:00:00 2001 From: Caden Marchese <56140267+cadenmarchese@users.noreply.github.com> Date: Thu, 23 Jan 2025 08:08:25 -0500 Subject: [PATCH 24/74] Add Azure Red Hat OpenShift 2024-08-12-preview API version (#30004) * commit latest API version first * ensures reviewers can see changes from new API * commit 2024-08-12-preview changes commit changes to readme * this file appears required for comparison with Azure types commit v2024-08-12-preview examples add descriptions to all new api fields adjust one of the code comments according to feedback on the Red Hat side add platformworkloadidentityroleset + examples fix relative path to common-types use common-types files directly rather than copying them into the redhatopenshift directory use common-types/v6, use ManagedServiceIdentity type definition fix Swagger SpellCheck remove "format":"uuid" from clientIds, principalIds, tenantIds attempt to fix Swagger LintDiff check convert platformWorkloadIdentities to map identity -> managedServiceIdentity rename managedServiceIdentity back to identity, use common-types directly fix UNRESOLVABLE_REFERENCE fix relative path to common types attempt to fix UNRESOLVABLE_REFERENCE fix OBJECT_MISSING_REQUIRED_PROPERTY by fixing examples attempt to fix PatchBodyParametersSchema * suppress avoidAdditionalProperties * recieved signoff from ARM team to use additionalProperties during API modeling call * fix SDK generation (duplicate type definitions) * fix SDK generation * migrate all references to common-types v6 attempt to fix SDK generation * fix ModelValidation * suppress PatchBodyParametersSchema as this patch body comes from common-types and is required * correct platformworkloadidentityrolesets to be plural * add where clause to suppressions, add reason * fix CI suppressions (where and from clauses) * Resolve ARM feedback * add singleton GETs for openShiftVersions and PWIRS * remove unused resource types machinePool, syncSet, secret, and syncIdentityProvider after a conversation with my team, as they were never used, there are no routes in our API to handle them, and they are not included in our ARM manifests * camelCase fixes * resolve Swagger ModelValidation * convert cspell to new format (see PR#32171) * add 'oidc' to cspell to resolve swagger spell check CI failure --- specification/redhatopenshift/cspell.yaml | 4 +- .../OpenShiftClusters_CreateOrUpdate.json | 211 +++ .../examples/OpenShiftClusters_Delete.json | 16 + .../examples/OpenShiftClusters_Get.json | 117 ++ .../examples/OpenShiftClusters_List.json | 119 ++ ...penShiftClusters_ListAdminCredentials.json | 15 + ...OpenShiftClusters_ListByResourceGroup.json | 120 ++ .../OpenShiftClusters_ListCredentials.json | 16 + .../examples/OpenShiftClusters_Update.json | 210 +++ .../examples/OpenShiftVersions_Get.json | 20 + .../examples/OpenShiftVersions_List.json | 23 + .../examples/Operations_List.json | 21 + .../PlatformWorkloadIdentityRoleSet_Get.json | 27 + ...PlatformWorkloadIdentityRoleSets_List.json | 30 + .../2024-08-12-preview/redhatopenshift.json | 1369 +++++++++++++++++ .../openshiftclusters/readme.md | 84 +- 16 files changed, 2365 insertions(+), 37 deletions(-) create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_CreateOrUpdate.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Delete.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Get.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_List.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListAdminCredentials.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListByResourceGroup.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListCredentials.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Update.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_Get.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_List.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/Operations_List.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSet_Get.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSets_List.json create mode 100644 specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json diff --git a/specification/redhatopenshift/cspell.yaml b/specification/redhatopenshift/cspell.yaml index f1752c5f66a3..1c65f032dd49 100644 --- a/specification/redhatopenshift/cspell.yaml +++ b/specification/redhatopenshift/cspell.yaml @@ -10,4 +10,6 @@ import: words: - kubeadmin - snat - + - platformworkloadidentityroleset + - platformworkloadidentityrolesets + - oidc diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_CreateOrUpdate.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_CreateOrUpdate.json new file mode 100644 index 000000000000..885566487cd0 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_CreateOrUpdate.json @@ -0,0 +1,211 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup", + "resourceName": "resourceName", + "parameters": { + "location": "location", + "tags": { + "key": "value" + }, + "properties": { + "clusterProfile": { + "pullSecret": "{\"auths\":{\"registry.connect.redhat.com\":{\"auth\":\"\"},\"registry.redhat.io\":{\"auth\":\"\"}}}", + "domain": "cluster.location.aroapp.io", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup", + "fipsValidatedModules": "Enabled" + }, + "consoleProfile": {}, + "servicePrincipalProfile": { + "clientId": "clientId", + "clientSecret": "clientSecret" + }, + "platformWorkloadIdentityProfile": { + "platformWorkloadIdentities": { + "": {} + } + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "loadBalancerProfile": { + "managedOutboundIps": { + "count": 1 + } + }, + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master", + "encryptionAtHost": "Enabled" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "apiserverProfile": { + "visibility": "Public" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Delete.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Delete.json new file mode 100644 index 000000000000..3247ea3ef4cd --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup", + "resourceName": "resourceName" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Get.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Get.json new file mode 100644 index 000000000000..91b4b1c293ff --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Get.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "platformWorkloadIdentityProfile": { + "platformWorkloadIdentities": { + "": {} + } + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "loadBalancerProfile": { + "managedOutboundIps": { + "count": 1 + }, + "effectiveOutboundIps": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup/providers/Microsoft.Network/publicIPAddresses/publicIPAddressName" + } + ] + }, + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "workerProfilesStatus": [ + { + "name": "worker1", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + }, + { + "name": "worker2", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + }, + { + "name": "worker3", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_List.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_List.json new file mode 100644 index 000000000000..73039e0f4892 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_List.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "platformWorkloadIdentityProfile": { + "platformWorkloadIdentities": { + "": {} + } + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "loadBalancerProfile": { + "managedOutboundIps": { + "count": 1 + }, + "effectiveOutboundIps": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup/providers/Microsoft.Network/publicIPAddresses/publicIPAddressName" + } + ] + }, + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "workerProfilesStatus": [ + { + "name": "worker1", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + }, + { + "name": "worker2", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + }, + { + "name": "worker3", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + ] + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListAdminCredentials.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListAdminCredentials.json new file mode 100644 index 000000000000..32306bed8066 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListAdminCredentials.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "kubeconfig": "e30=" + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListByResourceGroup.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..7b4fbb839545 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListByResourceGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "platformWorkloadIdentityProfile": { + "platformWorkloadIdentities": { + "": {} + } + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "loadBalancerProfile": { + "managedOutboundIps": { + "count": 1 + }, + "effectiveOutboundIps": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup/providers/Microsoft.Network/publicIPAddresses/publicIPAddressName" + } + ] + }, + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "workerProfilesStatus": [ + { + "name": "worker1", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + }, + { + "name": "worker2", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + }, + { + "name": "worker3", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 1 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + ] + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListCredentials.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListCredentials.json new file mode 100644 index 000000000000..a2ef1dac2da8 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_ListCredentials.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "kubeadminUsername": "kubeadmin", + "kubeadminPassword": "password" + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Update.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Update.json new file mode 100644 index 000000000000..add7615e8633 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftClusters_Update.json @@ -0,0 +1,210 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup", + "resourceName": "resourceName", + "parameters": { + "tags": { + "key": "value" + }, + "properties": { + "clusterProfile": { + "pullSecret": "{\"auths\":{\"registry.connect.redhat.com\":{\"auth\":\"\"},\"registry.redhat.io\":{\"auth\":\"\"}}}", + "domain": "cluster.location.aroapp.io", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup", + "fipsValidatedModules": "Enabled" + }, + "consoleProfile": {}, + "servicePrincipalProfile": { + "clientId": "clientId", + "clientSecret": "clientSecret" + }, + "platformWorkloadIdentityProfile": { + "platformWorkloadIdentities": { + "": {} + } + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "loadBalancerProfile": { + "managedOutboundIps": { + "count": 1 + } + }, + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master", + "encryptionAtHost": "Enabled" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "apiserverProfile": { + "visibility": "Public" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/Microsoft.RedHatOpenShift/OpenShiftClusters/resourceName", + "name": "resourceName", + "type": "Microsoft.RedHatOpenShift/OpenShiftClusters", + "location": "location", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T01:01:01.1075056Z" + }, + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "clusterProfile": { + "domain": "cluster.location.aroapp.io", + "version": "4.11.0", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clusterResourceGroup" + }, + "consoleProfile": { + "url": "https://console-openshift-console.apps.cluster.location.aroapp.io/" + }, + "servicePrincipalProfile": { + "clientId": "clientId" + }, + "networkProfile": { + "podCidr": "10.128.0.0/14", + "serviceCidr": "172.30.0.0/16", + "preconfiguredNSG": "Disabled" + }, + "masterProfile": { + "vmSize": "Standard_D8s_v3", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/master" + }, + "workerProfiles": [ + { + "name": "worker", + "vmSize": "Standard_D2s_v3", + "diskSizeGB": 128, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/vnetResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet/subnets/worker", + "count": 3 + } + ], + "apiserverProfile": { + "visibility": "Public", + "url": "https://api.cluster.location.aroapp.io:6443/", + "ip": "1.2.3.4" + }, + "ingressProfiles": [ + { + "name": "default", + "visibility": "Public", + "ip": "1.2.3.4" + } + ] + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "": {} + } + } + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_Get.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_Get.json new file mode 100644 index 000000000000..bcad8a558c13 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location", + "openShiftVersion": "4.14.40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/resourceProviderNamespace/resourceType/resourceName", + "name": "4.10.20", + "type": "Microsoft.RedHatOpenShift/OpenShiftVersion", + "properties": { + "version": "4.10.20" + } + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_List.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_List.json new file mode 100644 index 000000000000..9c68b9cb5b03 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/OpenShiftVersions_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/resourceProviderNamespace/resourceType/resourceName", + "name": "4.10.20", + "type": "Microsoft.RedHatOpenShift/OpenShiftVersion", + "properties": { + "version": "4.10.20" + } + } + ] + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/Operations_List.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/Operations_List.json new file mode 100644 index 000000000000..ff35cace1755 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/Operations_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.RedHatOpenShift/openShiftClusters/read", + "display": { + "provider": "Azure Red Hat OpenShift", + "resource": "openShiftClusters", + "operation": "Read OpenShift cluster" + } + } + ] + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSet_Get.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSet_Get.json new file mode 100644 index 000000000000..18e77aa299bd --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSet_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location", + "openShiftMinorVersion": "4.14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/resourceProviderNamespace/resourceType/resourceName", + "name": "4.14", + "type": "Microsoft.RedHatOpenShift/PlatformWorkloadIdentityRoleSet", + "properties": { + "openShiftVersion": "4.14", + "platformWorkloadIdentityRoles": [ + { + "operatorName": "aro-operator", + "roleDefinitionName": "Azure Red Hat OpenShift Service Operator", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000" + } + ] + } + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSets_List.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSets_List.json new file mode 100644 index 000000000000..9d853269ac77 --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/examples/PlatformWorkloadIdentityRoleSets_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-12-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/resourceProviderNamespace/resourceType/resourceName", + "name": "4.14", + "type": "Microsoft.RedHatOpenShift/PlatformWorkloadIdentityRoleSet", + "properties": { + "openShiftVersion": "4.14", + "platformWorkloadIdentityRoles": [ + { + "operatorName": "aro-operator", + "roleDefinitionName": "Azure Red Hat OpenShift Service Operator", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json new file mode 100644 index 000000000000..a38df47489ae --- /dev/null +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/preview/2024-08-12-preview/redhatopenshift.json @@ -0,0 +1,1369 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Red Hat OpenShift Client", + "description": "Rest API for Azure Red Hat OpenShift 4", + "version": "2024-08-12-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.RedHatOpenShift/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available RP operations.", + "description": "The operation returns the RP operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all of the available RP operations.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/openShiftVersions": { + "get": { + "tags": [ + "OpenShiftVersions" + ], + "summary": "Lists all OpenShift versions available to install in the specified location.", + "description": "The operation returns the installable OpenShift versions as a string.", + "operationId": "OpenShiftVersions_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all OpenShift versions available to install in the specified location.": { + "$ref": "./examples/OpenShiftVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/openShiftVersions/{openShiftVersion}": { + "get": { + "tags": [ + "OpenShiftVersions" + ], + "summary": "Gets an available OpenShift version to install in the specified location.", + "description": "This operation returns installable OpenShift version as a string.", + "operationId": "OpenShiftVersions_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" + }, + { + "name": "openShiftVersion", + "in": "path", + "description": "The desired version value of the OpenShiftVersion resource.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 1, + "pattern": "^(\\d+)\\.(\\d+)\\.(\\d+)(.*)" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets an available OpenShift version to install in the specified location.": { + "$ref": "./examples/OpenShiftVersions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/platformWorkloadIdentityRoleSets": { + "get": { + "tags": [ + "PlatformWorkloadIdentityRoleSets" + ], + "summary": "Lists a mapping of OpenShift versions to identity requirements, which include operatorName, roleDefinitionName, roleDefinitionId, and serviceAccounts.", + "description": "This operation returns a list of Platform Workload Identity Role Sets as a string", + "operationId": "PlatformWorkloadIdentityRoleSets_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlatformWorkloadIdentityRoleSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists a mapping of OpenShift versions to identity requirements, which include operatorName, roleDefinitionName, roleDefinitionId, and serviceAccounts.": { + "$ref": "./examples/PlatformWorkloadIdentityRoleSets_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/locations/{location}/platformWorkloadIdentityRoleSets/{openShiftMinorVersion}": { + "get": { + "tags": [ + "PlatformWorkloadIdentityRoleSets" + ], + "summary": "Gets a mapping of an OpenShift version to identity requirements, which includes operatorName, roleDefinitionName, roleDefinitionId, and serviceAccounts.", + "description": "This operation returns Platform Workload Identity Role Set as a string", + "operationId": "PlatformWorkloadIdentityRoleSet_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" + }, + { + "name": "openShiftMinorVersion", + "in": "path", + "description": "The desired version value of the PlatformWorkloadIdentityRoleSet resource.", + "required": true, + "type": "string", + "maxLength": 63, + "minLength": 1, + "pattern": "^(\\d+)\\.(\\d+)" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PlatformWorkloadIdentityRoleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets a mapping of an OpenShift version to identity requirements, which includes operatorName, roleDefinitionName, roleDefinitionId, and serviceAccounts.": { + "$ref": "./examples/PlatformWorkloadIdentityRoleSet_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.RedHatOpenShift/openShiftClusters": { + "get": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Lists OpenShift clusters in the specified subscription.", + "description": "The operation returns properties of each OpenShift cluster.", + "operationId": "OpenShiftClusters_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists OpenShift clusters in the specified subscription.": { + "$ref": "./examples/OpenShiftClusters_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters": { + "get": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Lists OpenShift clusters in the specified subscription and resource group.", + "description": "The operation returns properties of each OpenShift cluster.", + "operationId": "OpenShiftClusters_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists OpenShift clusters in the specified subscription and resource group.": { + "$ref": "./examples/OpenShiftClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}": { + "get": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Gets a OpenShift cluster with the specified subscription, resource group and resource name.", + "description": "The operation returns properties of a OpenShift cluster.", + "operationId": "OpenShiftClusters_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the OpenShift cluster resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets a OpenShift cluster with the specified subscription, resource group and resource name.": { + "$ref": "./examples/OpenShiftClusters_Get.json" + } + } + }, + "put": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.", + "description": "The operation returns properties of a OpenShift cluster.", + "operationId": "OpenShiftClusters_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the OpenShift cluster resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The OpenShift cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/OpenShiftCluster" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OpenShiftCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.": { + "$ref": "./examples/OpenShiftClusters_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Deletes a OpenShift cluster with the specified subscription, resource group and resource name.", + "description": "The operation returns nothing.", + "operationId": "OpenShiftClusters_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the OpenShift cluster resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a OpenShift cluster with the specified subscription, resource group and resource name.": { + "$ref": "./examples/OpenShiftClusters_Delete.json" + } + } + }, + "patch": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.", + "description": "The operation returns properties of a OpenShift cluster.", + "operationId": "OpenShiftClusters_Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the OpenShift cluster resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The OpenShift cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/OpenShiftClusterUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OpenShiftCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.": { + "$ref": "./examples/OpenShiftClusters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}/listAdminCredentials": { + "post": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name.", + "description": "The operation returns the admin kubeconfig.", + "operationId": "OpenShiftClusters_ListAdminCredentials", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the OpenShift cluster resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftClusterAdminKubeconfig" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name.": { + "$ref": "./examples/OpenShiftClusters_ListAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}/listCredentials": { + "post": { + "tags": [ + "OpenShiftClusters" + ], + "summary": "Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.", + "description": "The operation returns the credentials.", + "operationId": "OpenShiftClusters_ListCredentials", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "The name of the OpenShift cluster resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftClusterCredentials" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource doesn't exist, 404 (Not Found) is returned. If any of the input parameters is wrong, 400 (Bad Request) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.": { + "$ref": "./examples/OpenShiftClusters_ListCredentials.json" + } + } + } + } + }, + "definitions": { + "APIServerProfile": { + "description": "APIServerProfile represents an API server profile.", + "type": "object", + "properties": { + "visibility": { + "$ref": "#/definitions/Visibility", + "description": "API server visibility." + }, + "url": { + "description": "The URL to access the cluster API server.", + "type": "string", + "readOnly": true + }, + "ip": { + "description": "The IP of the cluster API server.", + "type": "string", + "readOnly": true + } + } + }, + "CloudError": { + "description": "CloudError represents a cloud error.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "An error response from the service." + } + } + }, + "CloudErrorBody": { + "description": "CloudErrorBody represents the body of a cloud error.", + "type": "object", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "target": { + "description": "The target of the particular error. For example, the name of the property in error.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterProfile": { + "description": "ClusterProfile represents a cluster profile.", + "type": "object", + "properties": { + "pullSecret": { + "description": "The pull secret for the cluster.", + "type": "string" + }, + "domain": { + "description": "The domain for the cluster.", + "type": "string" + }, + "version": { + "description": "The version of the cluster.", + "type": "string" + }, + "resourceGroupId": { + "description": "The ID of the cluster resource group.", + "type": "string" + }, + "fipsValidatedModules": { + "$ref": "#/definitions/FipsValidatedModules", + "description": "If FIPS validated crypto modules are used" + }, + "oidcIssuer": { + "$ref": "#/definitions/OIDCIssuer", + "description": "The URL of the managed OIDC issuer in a workload identity cluster." + } + } + }, + "ConsoleProfile": { + "description": "ConsoleProfile represents a console profile.", + "type": "object", + "properties": { + "url": { + "description": "The URL to access the cluster console.", + "type": "string", + "readOnly": true + } + } + }, + "Display": { + "description": "Display represents the display details of an operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation.", + "type": "string" + } + } + }, + "EffectiveOutboundIP": { + "description": "EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.", + "type": "object", + "properties": { + "id": { + "description": "The fully qualified Azure resource id of an IP address resource.", + "type": "string" + } + } + }, + "EncryptionAtHost": { + "description": "EncryptionAtHost represents encryption at host state", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAtHost", + "modelAsString": true + } + }, + "FipsValidatedModules": { + "description": "FipsValidatedModules determines if FIPS is used.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "FipsValidatedModules", + "modelAsString": true + } + }, + "IngressProfile": { + "description": "IngressProfile represents an ingress profile.", + "type": "object", + "properties": { + "name": { + "description": "The ingress profile name.", + "type": "string" + }, + "visibility": { + "$ref": "#/definitions/Visibility", + "description": "Ingress visibility." + }, + "ip": { + "description": "The IP of the ingress.", + "type": "string", + "readOnly": true + } + } + }, + "LoadBalancerProfile": { + "description": "LoadBalancerProfile represents the profile of the cluster public load balancer.", + "type": "object", + "properties": { + "managedOutboundIps": { + "$ref": "#/definitions/ManagedOutboundIPs", + "description": "The desired managed outbound IPs for the cluster public load balancer." + }, + "effectiveOutboundIps": { + "description": "The list of effective outbound IP addresses of the public load balancer.", + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveOutboundIP" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ManagedOutboundIPs": { + "description": "ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.", + "type": "object", + "properties": { + "count": { + "format": "int32", + "description": "Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1.", + "type": "integer" + } + } + }, + "MasterProfile": { + "description": "MasterProfile represents a master profile.", + "type": "object", + "properties": { + "vmSize": { + "$ref": "#/definitions/VMSize", + "description": "The size of the master VMs." + }, + "subnetId": { + "description": "The Azure resource ID of the master subnet.", + "type": "string" + }, + "encryptionAtHost": { + "$ref": "#/definitions/EncryptionAtHost", + "description": "Whether master virtual machines are encrypted at host." + }, + "diskEncryptionSetId": { + "description": "The resource ID of an associated DiskEncryptionSet, if applicable.", + "type": "string" + } + } + }, + "NetworkProfile": { + "description": "NetworkProfile represents a network profile.", + "type": "object", + "properties": { + "podCidr": { + "description": "The CIDR used for OpenShift/Kubernetes Pods.", + "type": "string" + }, + "serviceCidr": { + "description": "The CIDR used for OpenShift/Kubernetes Services.", + "type": "string" + }, + "outboundType": { + "$ref": "#/definitions/OutboundType", + "description": "The OutboundType used for egress traffic." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/LoadBalancerProfile", + "description": "The cluster load balancer profile." + }, + "preconfiguredNSG": { + "$ref": "#/definitions/PreconfiguredNSG", + "description": "Specifies whether subnets are pre-attached with an NSG" + } + } + }, + "OIDCIssuer": { + "description": "OIDCIssuer represents the URL of the managed OIDC issuer in a workload identity cluster.", + "type": "string" + }, + "OpenShiftCluster": { + "description": "OpenShiftCluster represents an Azure Red Hat OpenShift cluster.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OpenShiftClusterProperties", + "description": "The cluster properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "Identity stores information about the cluster MSI(s) in a workload identity cluster." + } + } + }, + "OpenShiftClusterAdminKubeconfig": { + "description": "OpenShiftClusterAdminKubeconfig represents an OpenShift cluster's admin kubeconfig.", + "type": "object", + "properties": { + "kubeconfig": { + "description": "The base64-encoded kubeconfig file.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OpenShiftClusterCredentials": { + "description": "OpenShiftClusterCredentials represents an OpenShift cluster's credentials.", + "type": "object", + "properties": { + "kubeadminUsername": { + "description": "The username for the kubeadmin user.", + "type": "string" + }, + "kubeadminPassword": { + "description": "The password for the kubeadmin user.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OpenShiftClusterList": { + "description": "OpenShiftClusterList represents a list of OpenShift clusters.", + "type": "object", + "properties": { + "value": { + "description": "The list of OpenShift clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/OpenShiftCluster" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + } + }, + "OpenShiftClusterProperties": { + "description": "OpenShiftClusterProperties represents an OpenShift cluster's properties.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The cluster provisioning state." + }, + "clusterProfile": { + "$ref": "#/definitions/ClusterProfile", + "description": "The cluster profile." + }, + "consoleProfile": { + "$ref": "#/definitions/ConsoleProfile", + "description": "The console profile." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ServicePrincipalProfile", + "description": "The cluster service principal profile." + }, + "platformWorkloadIdentityProfile": { + "$ref": "#/definitions/PlatformWorkloadIdentityProfile", + "description": "The workload identity profile." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "The cluster network profile." + }, + "masterProfile": { + "$ref": "#/definitions/MasterProfile", + "description": "The cluster master profile." + }, + "workerProfiles": { + "description": "The cluster worker profiles.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkerProfile" + }, + "x-ms-identifiers": [] + }, + "workerProfilesStatus": { + "description": "The cluster worker profiles status.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkerProfile" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "apiserverProfile": { + "$ref": "#/definitions/APIServerProfile", + "description": "The cluster API server profile." + }, + "ingressProfiles": { + "description": "The cluster ingress profiles.", + "type": "array", + "items": { + "$ref": "#/definitions/IngressProfile" + }, + "x-ms-identifiers": [] + } + } + }, + "OpenShiftClusterUpdate": { + "description": "OpenShiftCluster represents an Azure Red Hat OpenShift cluster.", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags", + "description": "The resource tags." + }, + "properties": { + "$ref": "#/definitions/OpenShiftClusterProperties", + "description": "The cluster properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "Identity stores information about the cluster MSI(s) in a workload identity cluster." + } + } + }, + "OpenShiftVersion": { + "description": "OpenShiftVersion represents an OpenShift version that can be installed.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OpenShiftVersionProperties", + "description": "The properties for the OpenShiftVersion resource.", + "x-ms-client-flatten": true + } + } + }, + "OpenShiftVersionList": { + "description": "OpenShiftVersionList represents a List of available versions.", + "type": "object", + "properties": { + "value": { + "description": "The List of available versions.", + "type": "array", + "items": { + "$ref": "#/definitions/OpenShiftVersion" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Next Link to next operation.", + "type": "string" + } + } + }, + "OpenShiftVersionProperties": { + "description": "OpenShiftVersionProperties represents the properties of an OpenShiftVersion.", + "type": "object", + "properties": { + "version": { + "description": "Version represents the version to create the cluster at.", + "type": "string" + } + } + }, + "Operation": { + "description": "Operation represents an RP operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/Display", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Sources of requests to this operation. Comma separated list with valid values user or system, e.g. \"user,system\".", + "type": "string" + } + } + }, + "OperationList": { + "description": "OperationList represents an RP operation list.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + } + }, + "OutboundType": { + "description": "The outbound routing strategy used to provide your cluster egress to the internet.", + "enum": [ + "Loadbalancer", + "UserDefinedRouting" + ], + "type": "string", + "x-ms-enum": { + "name": "OutboundType", + "modelAsString": true + } + }, + "PlatformWorkloadIdentity": { + "description": "PlatformWorkloadIdentity stores information representing a single workload identity.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the PlatformWorkloadIdentity resource", + "type": "string" + }, + "clientId": { + "description": "The ClientID of the PlatformWorkloadIdentity resource", + "type": "string", + "readOnly": true + }, + "objectId": { + "description": "The ObjectID of the PlatformWorkloadIdentity resource", + "type": "string", + "readOnly": true + } + } + }, + "PlatformWorkloadIdentityProfile": { + "description": "PlatformWorkloadIdentityProfile encapsulates all information that is specific to workload identity clusters.", + "type": "object", + "properties": { + "upgradeableTo": { + "$ref": "#/definitions/UpgradeableTo" + }, + "platformWorkloadIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PlatformWorkloadIdentity" + } + } + } + }, + "PlatformWorkloadIdentityRole": { + "description": "PlatformWorkloadIdentityRole represents a mapping from a particular OCP operator to the built-in role that should be assigned to that operator's corresponding managed identity.", + "type": "object", + "properties": { + "operatorName": { + "description": "OperatorName represents the name of the operator that this role is for.", + "type": "string" + }, + "roleDefinitionName": { + "description": "RoleDefinitionName represents the name of the role.", + "type": "string" + }, + "roleDefinitionId": { + "description": "RoleDefinitionID represents the resource ID of the role definition.", + "type": "string" + } + } + }, + "PlatformWorkloadIdentityRoleSet": { + "description": "PlatformWorkloadIdentityRoleSet represents a mapping from the names of OCP operators to the built-in roles that should be assigned to those operator's corresponding managed identities for a particular OCP version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PlatformWorkloadIdentityRoleSetProperties", + "description": "The properties for the PlatformWorkloadIdentityRoleSet resource.", + "x-ms-client-flatten": true + } + } + }, + "PlatformWorkloadIdentityRoleSetList": { + "description": "PlatformWorkloadIdentityRoleSetList represents a List of role sets.", + "type": "object", + "properties": { + "value": { + "description": "The list of role sets.", + "type": "array", + "items": { + "$ref": "#/definitions/PlatformWorkloadIdentityRoleSet" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Next Link to next operation.", + "type": "string" + } + } + }, + "PlatformWorkloadIdentityRoleSetProperties": { + "description": "PlatformWorkloadIdentityRoleSetProperties represents the properties of a PlatformWorkloadIdentityRoleSet resource.", + "type": "object", + "properties": { + "openShiftVersion": { + "description": "OpenShiftVersion represents the version associated with this set of roles.", + "type": "string" + }, + "platformWorkloadIdentityRoles": { + "description": "PlatformWorkloadIdentityRoles represents the set of roles associated with this version.", + "type": "array", + "items": { + "$ref": "#/definitions/PlatformWorkloadIdentityRole" + }, + "x-ms-identifiers": [] + } + } + }, + "PreconfiguredNSG": { + "description": "PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PreconfiguredNSG", + "modelAsString": true + } + }, + "ProvisioningState": { + "description": "ProvisioningState represents a provisioning state.", + "enum": [ + "AdminUpdating", + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ServicePrincipalProfile": { + "description": "ServicePrincipalProfile represents a service principal profile.", + "type": "object", + "properties": { + "clientId": { + "description": "The client ID used for the cluster.", + "type": "string" + }, + "clientSecret": { + "description": "The client secret used for the cluster.", + "type": "string" + } + } + }, + "Tags": { + "description": "Tags represents an OpenShift cluster's tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "UpgradeableTo": { + "description": "UpgradeableTo stores a single OpenShift version a workload identity cluster can be upgraded to", + "type": "string" + }, + "VMSize": { + "description": "VM size availability varies by region.\nIf a node contains insufficient compute resources (memory, cpu, etc.), pods might fail to run correctly.\nFor more details on restricted VM sizes, see: https://docs.microsoft.com/en-us/azure/openshift/support-policies-v4#supported-virtual-machine-sizes", + "type": "string" + }, + "Visibility": { + "description": "Visibility represents visibility.", + "enum": [ + "Private", + "Public" + ], + "type": "string", + "x-ms-enum": { + "name": "Visibility", + "modelAsString": true + } + }, + "WorkerProfile": { + "description": "WorkerProfile represents a worker profile.", + "type": "object", + "properties": { + "name": { + "description": "The worker profile name.", + "type": "string" + }, + "vmSize": { + "$ref": "#/definitions/VMSize", + "description": "The size of the worker VMs." + }, + "diskSizeGB": { + "format": "int32", + "description": "The disk size of the worker VMs.", + "type": "integer" + }, + "subnetId": { + "description": "The Azure resource ID of the worker subnet.", + "type": "string" + }, + "count": { + "format": "int32", + "description": "The number of worker VMs.", + "type": "integer" + }, + "encryptionAtHost": { + "$ref": "#/definitions/EncryptionAtHost", + "description": "Whether master virtual machines are encrypted at host." + }, + "diskEncryptionSetId": { + "description": "The resource ID of an associated DiskEncryptionSet, if applicable.", + "type": "string" + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API the caller wants to use.", + "required": true, + "type": "string", + "pattern": "^\\d{2}-\\d{2}-\\d{4}(-preview)?$", + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.md b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.md index 91425ddd999e..cbadbdab824c 100644 --- a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.md +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/openshiftclusters/readme.md @@ -26,34 +26,16 @@ These are the global settings for the Azure Red Hat OpenShift API. ``` yaml openapi-type: arm -tag: package-2023-11 -``` - - -### Tag: package-2023-11 - -These settings apply only when `--tag=package-2023-11` is specified on the command line. - -```yaml $(tag) == 'package-2023-11' -input-file: - - stable/2023-11-22/redhatopenshift.json -``` -### Tag: package-2023-09-04 - -These settings apply only when `--tag=package-2023-09-04` is specified on the command line. - -``` yaml $(tag) == 'package-2023-09-04' -input-file: - - stable/2023-09-04/redhatopenshift.json -``` - -### 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: - - preview/2023-07-01-preview/redhatopenshift.json +tag: package-2024-08-12-preview +suppressions: + - code: AvoidAdditionalProperties + from: redhatopenshift.json + reason: We require additionalProperties (map) because the keys (platformWorkloadIdentity) can change according to OpenShift version, and we don’t want to bind the key to a specific API version. This was noted as a valid use case by the ARM team. + where: $.definitions.PlatformWorkloadIdentityProfile.properties.platformWorkloadIdentities + - code: PatchBodyParametersSchema + from: redhatopenshift.json + reason: False positive based on Azure common types. Managed Service Identity requires type, and the Managed Service Identity can be patched. + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RedHatOpenShift/openShiftClusters/{resourceName}"].patch.parameters[4].schema.properties.identity ``` ### Tag: package-2020-04-30 @@ -74,6 +56,15 @@ input-file: - preview/2021-09-01-preview/redhatopenshift.json ``` +### Tag: package-2023-07-01-preview + +These settings apply only when `--tag=package-2023-07-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-07-01-preview' +input-file: + - preview/2023-07-01-preview/redhatopenshift.json +``` + ### Tag: package-2022-04-01 These settings apply only when `--tag=package-2022-04-01` is specified on the command line. @@ -101,6 +92,32 @@ input-file: - stable/2023-04-01/redhatopenshift.json ``` +### Tag: package-2023-09-04 + +These settings apply only when `--tag=package-2023-09-04` is specified on the command line. + +``` yaml $(tag) == 'package-2023-09-04' +input-file: + - stable/2023-09-04/redhatopenshift.json +``` + +### Tag: package-2023-11 + +These settings apply only when `--tag=package-2023-11` is specified on the command line. + +``` yaml $(tag) == 'package-2023-11' +input-file: + - stable/2023-11-22/redhatopenshift.json +``` + +### Tag: package-2024-08-12-preview + +These settings apply only when `--tag=package-2024-08-12-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-08-12-preview' +input-file: + - preview/2024-08-12-preview/redhatopenshift.json +``` --- # Code Generation @@ -110,13 +127,13 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -``` yaml $(swagger-to-sdk) +```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go + - repo: azure-sdk-for-go-track2 - repo: azure-resource-manager-schemas - repo: azure-powershell - - repo: azure-sdk-for-js ``` ## Go @@ -126,8 +143,3 @@ See configuration in [readme.go.md](./readme.go.md) ## Python See configuration in [readme.python.md](./readme.python.md) - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - From d83ac864ad4d0819f6d0c36f000f864fc0953819 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Thu, 23 Jan 2025 23:00:28 +0800 Subject: [PATCH 25/74] Update service-dir for pineconevectordb && update tsp config for servicenetworking (#32273) * Update tspconfig.yaml * update --- .../liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml | 4 +--- .../ServiceNetworking.Management/tspconfig.yaml | 1 + 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml index ccdbd5478fa9..c1e7d3409d00 100644 --- a/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml +++ b/specification/liftrpinecone/Pinecone.VectorDb.Management/tspconfig.yaml @@ -2,7 +2,7 @@ emit: - "@azure-tools/typespec-autorest" parameters: "service-dir": - default: "sdk/liftrpinecone" + default: "sdk/pineconevectordb" options: "@azure-tools/typespec-autorest": use-read-only-status-schema: true @@ -29,14 +29,12 @@ options: packageDetails: name: "@azure/arm-pineconevectordb" "@azure-tools/typespec-python": - service-dir: "sdk/pineconevectordb" package-dir: "azure-mgmt-pineconevectordb" package-name: "{package-dir}" flavor: "azure" generate-test: true generate-sample: true "@azure-tools/typespec-java": - service-dir: "sdk/pineconevectordb" package-dir: "azure-resourcemanager-pineconevectordb" flavor: "azure" service-name: "Pinecone Vector Db" diff --git a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml index 145f8a6cc3dd..b0c2ac3d4aa2 100644 --- a/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml +++ b/specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml @@ -25,6 +25,7 @@ options: hierarchyClient: false experimentalExtensibleEnums: true enableOperationGroup: true + generateSample: true package-dir: "arm-servicenetworking" flavor: "azure" packageDetails: From 5d2c1c4249968778f6fb5e5bf86eef3b1a26f076 Mon Sep 17 00:00:00 2001 From: Joshua Qin Date: Thu, 23 Jan 2025 09:50:08 -0800 Subject: [PATCH 26/74] Documented previously missing AMPLS API versions in new service subfolder (#31826) * base commit replicating 2021-07-01-preview * Add new version of Private Links API to support metrics Following changes were made: - Added `kind` and `location` fields to Scoped Resource types: kind can currently represent either `resource`, which are all existing kinds of scoped resource, or `metrics` - Added an optional `kind` query parameter to `PrivateLinkScopesList` endpoint, for filtering - Added examples demonstrating use of the new endpoints - Fixed some typos from previous API versions * Updated examples to use the latest version * updated readme to include reference to the latest API version * fixed tag on the new API version in the readme * added the latest api version to the default tag * rolled back previous changes * Fixed MissingTypeObject, ResourceNameRestriction * Rolled back changes * changed microsoft.insights to Microsoft.Insights because apparently the lowercased version doesn't match the namespace * rearranged parameters in private link scope operation statuses * Updated default error response * Added headers for long running oeprations * Tried to correct error response templates to match the common definitions * Changed location to subscriptionLocation * Attempt to solve OperationsAPIImplementation * Revert previous change * Test moving LRO response headers * Test moving LRO response headers part 2 * Added suppression for Operations API * Following advice from reviewer to remove the 'where' tag * changed 'metrics' to 'platformMetrics', fixed examples, added example * fixed grammar error * Added enumerated values for provisioning state * introduced x-ms-enum properties * fixed examples error * changed x-ms-enum names * Added 'Canceled' to provisioningState' * attempt to solve LroLocationHeader lintdiff error * solve all the LroHeaderLocation LintDiff locations * attempt to solve DeleteResponseCodes * Fix model validation error * made kind an enum * made new fields readonly * Resolved the duplicate names issue and added a breaking change suppression * Attempt to fix the suppression for OperationsApi * Attempt to fix the suppression for OperationsApi by replicating previous pattern * Attempt to fix suppressions for lintdiff errors * removed the readonly flagged on the kind parameter - not necessary, and I'm not allowed to have readonly in the request anyway * Changed 'true' to true, fixed x-ms-enum name repeat * Changed casing * Changed enum casing * Revert "Changed enum casing" This reverts commit 16d4fe033d6f828650659274d8ab4033491061ba. * removed readonly * Changed casing for kind * Test suppressions * Added suppressions for all the long-running operations lintdiff errors * Remove suppression for resourceNameRestriction to see what breaks * re-committed resource name restriction suppression * Copied private link scopes API into subfolder * Deleted duplicated api versions * Deleted 2023-06-01 from parent * reverted readme files in parent * Test git files diff * Fixed relative directories * Added location headers for async requests * Fixed location headers format * fixed location headers in examples * fixed last location header * Try modification for autorest configuration * RP naming in PascalCase * Fixed remaining lintdiff errors by copying from 2023-06-01-preview * removed unused 200 response code in delete private link scopes * Remove typespec requirements * Added typespec suppressions to preview api --- .../PrivateEndpointConnectionDelete.json | 18 + .../PrivateEndpointConnectionGet.json | 29 + .../PrivateEndpointConnectionList.json | 48 + .../PrivateEndpointConnectionUpdate.json | 42 + ...rivateLinkScopePrivateLinkResourceGet.json | 37 + ...teLinkScopePrivateLinkResourceListGet.json | 40 + .../PrivateLinkScopedResourceDelete.json | 18 + .../PrivateLinkScopedResourceGet.json | 31 + .../PrivateLinkScopedResourceList.json | 72 + ...ivateLinkScopedResourceListKindFilter.json | 53 + .../PrivateLinkScopedResourceUpdate.json | 62 + ...nkScopedResourceUpdatePlatformMetrics.json | 65 + .../examples/PrivateLinkScopesCreate.json | 70 + .../examples/PrivateLinkScopesDelete.json | 16 + .../examples/PrivateLinkScopesGet.json | 35 + .../examples/PrivateLinkScopesList.json | 61 + .../PrivateLinkScopesListByResourceGroup.json | 62 + .../examples/PrivateLinkScopesUpdate.json | 77 ++ .../PrivateLinkScopesUpdateTagsOnly.json | 44 + .../privateLinkScopeOperationStatuses.json | 20 + .../privateLinkScopes_API.json | 1163 +++++++++++++++++ .../PrivateLinkScopes/readme.go.md | 11 + .../PrivateLinkScopes/readme.md | 112 ++ .../PrivateEndpointConnectionDelete.json | 18 + .../PrivateEndpointConnectionGet.json | 29 + .../PrivateEndpointConnectionList.json | 48 + .../PrivateEndpointConnectionUpdate.json | 42 + ...rivateLinkScopePrivateLinkResourceGet.json | 37 + ...teLinkScopePrivateLinkResourceListGet.json | 40 + .../PrivateLinkScopedResourceDelete.json | 18 + .../PrivateLinkScopedResourceGet.json | 30 + .../PrivateLinkScopedResourceList.json | 50 + .../PrivateLinkScopedResourceUpdate.json | 55 + .../examples/PrivateLinkScopesCreate.json | 70 + .../examples/PrivateLinkScopesDelete.json | 16 + .../examples/PrivateLinkScopesGet.json | 35 + .../examples/PrivateLinkScopesList.json | 61 + .../PrivateLinkScopesListByResourceGroup.json | 62 + .../examples/PrivateLinkScopesUpdate.json | 77 ++ .../PrivateLinkScopesUpdateTagsOnly.json | 44 + .../privateLinkScopeOperationStatuses.json | 20 + .../2021-09-01/privateLinkScopes_API.json | 1124 ++++++++++++++++ specification/monitor/suppressions.yaml | 7 + 43 files changed, 4069 insertions(+) create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionDelete.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionList.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionUpdate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceDelete.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceList.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceListKindFilter.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdatePlatformMetrics.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesCreate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesDelete.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesList.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesListByResourceGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdateTagsOnly.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/privateLinkScopeOperationStatuses.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/privateLinkScopes_API.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.go.md create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.md create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionDelete.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionList.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionUpdate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceListGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceDelete.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceList.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceUpdate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesCreate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesDelete.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesGet.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesList.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesListByResourceGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdate.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdateTagsOnly.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/privateLinkScopeOperationStatuses.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/privateLinkScopes_API.json create mode 100644 specification/monitor/suppressions.yaml diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionDelete.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..0fa444d89882 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + }, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..b49da8411125 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionList.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..56ab19615b58 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name-2", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection.", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionUpdate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..dab39ab360af --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2023-06-01-preview", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json new file mode 100644 index 000000000000..0795740f994f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2023-06-01-preview", + "groupName": "azuremonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateLinkResources/azuremonitor", + "name": "azuremonitor", + "type": "Microsoft.Insights/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "azuremonitor", + "requiredMembers": [ + "api", + "global.in.ai", + "profiler", + "live", + "snapshot", + "agentsolutionpackstore", + "dce-global" + ], + "requiredZoneNames": [ + "privatelink.monitor.azure.com", + "privatelink.oms.opinsights.azure.com", + "privatelink.ods.opinsights.azure.com", + "privatelink.agentsvc.azure-automation.net", + "privatelink.blob.core.windows.net" + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json new file mode 100644 index 000000000000..ce35ba7d7787 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopePrivateLinkResourceListGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateLinkResources/azuremonitor", + "name": "azuremonitor", + "type": "Microsoft.Insights/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "azuremonitor", + "requiredMembers": [ + "api", + "global.in.ai", + "profiler", + "live", + "snapshot", + "agentsolutionpackstore", + "dce-global" + ], + "requiredZoneNames": [ + "privatelink.monitor.azure.com", + "privatelink.oms.opinsights.azure.com", + "privatelink.ods.opinsights.azure.com", + "privatelink.agentsvc.azure-automation.net", + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceDelete.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceDelete.json new file mode 100644 index 000000000000..02ff689afdb5 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + }, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceGet.json new file mode 100644 index 000000000000..8a62d6b1def1 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceList.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceList.json new file mode 100644 index 000000000000..6d3df898af4e --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name-one", + "name": "scoped-resource-name-one", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-0000-2222-3333-444444444444/resourceGroups/MyComponentResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name-two", + "name": "scoped-resource-name-two", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "PlatformMetrics", + "linkedResourceId": "/subscriptions/00000000-3333-2222-5555-444444444444", + "subscriptionLocation": "westus", + "provisioningState": "Provisioning" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name-three", + "name": "scoped-resource-name-three", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "PlatformMetrics", + "linkedResourceId": "/subscriptions/00000000-3333-2222-5555-444444444444", + "subscriptionLocation": "eastus", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceListKindFilter.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceListKindFilter.json new file mode 100644 index 000000000000..66b7540e8cc4 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceListKindFilter.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "kind": "Resource", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name-one", + "name": "scoped-resource-name-one", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-0000-2222-3333-444444444444/resourceGroups/MyComponentResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name-two", + "name": "scoped-resource-name-two", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-3333-2222-5555-444444444444/resourceGroups/MyWorkspaceResourceGroup/providers/Microsoft.OperationalInsights/workspaces/my-workspace", + "provisioningState": "Provisioning" + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdate.json new file mode 100644 index 000000000000..884e794dd37f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2023-06-01-preview", + "parameters": { + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "Resource", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdatePlatformMetrics.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdatePlatformMetrics.json new file mode 100644 index 000000000000..6688adf31c53 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopedResourceUpdatePlatformMetrics.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2023-06-01-preview", + "parameters": { + "properties": { + "kind": "PlatformMetrics", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444", + "subscriptionLocation": "eastus" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "PlatformMetrics", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444", + "subscriptionLocation": "eastus", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "kind": "PlatformMetrics", + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444", + "subscriptionLocation": "eastus", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesCreate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesCreate.json new file mode 100644 index 000000000000..ca7ae25eb52e --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesCreate.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "AzureMonitorPrivateLinkScopePayload": { + "location": "Global", + "properties": { + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesDelete.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesDelete.json new file mode 100644 index 000000000000..ce0cbb93c8b0 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesGet.json new file mode 100644 index 000000000000..aba9f3febe2d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesList.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesList.json new file mode 100644 index 000000000000..eee68c708a6e --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesList.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-other-resource-group/providers/microsoft.insights/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesListByResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesListByResourceGroup.json new file mode 100644 index 000000000000..ef51f5abe6c0 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdate.json new file mode 100644 index 000000000000..6d4e9f5743c5 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "AzureMonitorPrivateLinkScopePayload": { + "location": "Global", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": { + "Tag1": "Value1" + }, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": { + "Tag1": "Value1" + }, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdateTagsOnly.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdateTagsOnly.json new file mode 100644 index 000000000000..7ca275835cfc --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/PrivateLinkScopesUpdateTagsOnly.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "PrivateLinkScopeTags": { + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + }, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/privateLinkScopeOperationStatuses.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/privateLinkScopeOperationStatuses.json new file mode 100644 index 000000000000..c24fb3e35f7e --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/examples/privateLinkScopeOperationStatuses.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "MyResourceGroup", + "asyncOperationId": "713192d7-503f-477a-9cfe-4efc3ee2bd11", + "api-version": "2023-06-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/713192d7-503f-477a-9cfe-4efc3ee2bd11", + "name": "713192d7-503f-477a-9cfe-4efc3ee2bd11", + "startTime": "2017-01-01T13:13:13.933Z", + "endTime": "2017-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/privateLinkScopes_API.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/privateLinkScopes_API.json new file mode 100644 index 000000000000..fb6e62a61ebc --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/privateLinkScopes_API.json @@ -0,0 +1,1163 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "description": "Azure Monitor API reference for Private Links Scopes management.", + "version": "2023-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/privateLinkScopes": { + "get": { + "description": "Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.", + "operationId": "PrivateLinkScopes_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Monitor PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScopeListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopesList.json": { + "$ref": "./examples/PrivateLinkScopesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes": { + "get": { + "description": "Gets a list of Azure Monitor PrivateLinkScopes within a resource group.", + "operationId": "PrivateLinkScopes_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Monitor PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScopeListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeListByResourceGroup": { + "$ref": "./examples/PrivateLinkScopesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}": { + "delete": { + "description": "Deletes a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "204": { + "description": "The specified PrivateLinkScope does not exist." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateLinkScopesDelete": { + "$ref": "./examples/PrivateLinkScopesDelete.json" + } + } + }, + "get": { + "description": "Returns a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "An Azure Monitor PrivateLinkScope definition.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGet.json" + } + } + }, + "put": { + "description": "Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "PrivateLinkScopes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "AzureMonitorPrivateLinkScopePayload", + "description": "Properties that need to be specified to create or update a Azure Monitor PrivateLinkScope.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope is returned.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "201": { + "description": "Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeCreate": { + "$ref": "./examples/PrivateLinkScopesCreate.json" + }, + "PrivateLinkScopeUpdate": { + "$ref": "./examples/PrivateLinkScopesUpdate.json" + } + } + }, + "patch": { + "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "PrivateLinkScopes_UpdateTags", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "PrivateLinkScopeTags", + "description": "Updated tag information to set into the PrivateLinkScope instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Azure Monitor PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeUpdateTagsOnly": { + "$ref": "./examples/PrivateLinkScopesUpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}": { + "get": { + "x-ms-examples": { + "Get specific operation status": { + "$ref": "./examples/privateLinkScopeOperationStatuses.json" + } + }, + "tags": [ + "asyncOperations" + ], + "operationId": "PrivateLinkScopeOperationStatus_Get", + "description": "Get the status of an azure asynchronous operation associated with a private link scope operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "asyncOperationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id." + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Operation status.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted private endpoint connection." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a private link scope.", + "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a private link scope.": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}": { + "get": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Gets a scoped resource in a private link scope.", + "operationId": "PrivateLinkScopedResources_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "name", + "in": "path", + "description": "The name of the scoped resource object.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a scoped resource in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private link scoped resource.": { + "$ref": "./examples/PrivateLinkScopedResourceGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Add an Azure monitor scoped resource in the private link scope.", + "operationId": "PrivateLinkScopedResources_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "name", + "in": "path", + "description": "The name of the scoped resource object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedResource" + } + } + ], + "responses": { + "200": { + "description": "Successfully create or updated a new azure monitor scoped resource in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResource" + } + }, + "201": { + "description": "Successfully created a new azure monitor scoped resource in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a scoped resource in a private link scope.": { + "$ref": "./examples/PrivateLinkScopedResourceUpdate.json" + }, + "Update a scoped platform metrics subscription in a private link scope.": { + "$ref": "./examples/PrivateLinkScopedResourceUpdatePlatformMetrics.json" + } + } + }, + "delete": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Deletes an Azure monitor scoped resource with a given name.", + "operationId": "PrivateLinkScopedResources_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "name", + "in": "path", + "description": "The name of the scoped resource object.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted scoped resource." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Scoped resource does not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a scoped resource with a given name.": { + "$ref": "./examples/PrivateLinkScopedResourceDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources": { + "get": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Gets all scoped resources on a private link scope.", + "operationId": "PrivateLinkScopedResources_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "kind", + "in": "query", + "required": false, + "description": "The kind of the private link resource. Not specifying a kind will return scoped resources of all kinds.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scoped resources in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResourceListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of scoped resources in a private link scope.": { + "$ref": "./examples/PrivateLinkScopedResourceList.json" + }, + "Gets list of scoped resources in a private link scope, filtered by kind.": { + "$ref": "./examples/PrivateLinkScopedResourceListKindFilter.json" + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "description": "The status of operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation Id." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Start time of the job in standard ISO8601 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "End time of the job in standard ISO8601 format." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "type": "object", + "description": "The error detail of the operation if any.", + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", + "x-nullable": true + } + } + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags", + "type": "object" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.", + "type": "object" + }, + "AzureMonitorPrivateLinkScope": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties that define a Azure Monitor PrivateLinkScope resource.", + "$ref": "#/definitions/AzureMonitorPrivateLinkScopeProperties" + }, + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System data", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "An Azure Monitor PrivateLinkScope definition.", + "type": "object" + }, + "AzureMonitorPrivateLinkScopeProperties": { + "description": "Properties that define a Azure Monitor PrivateLinkScope resource.", + "type": "object", + "properties": { + "provisioningState": { + "enum": [ + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "PrivateLinkScopeProvisioningState", + "modelAsString": true + }, + "type": "string", + "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.", + "readOnly": true + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "accessModeSettings": { + "type": "object", + "$ref": "#/definitions/AccessModeSettings", + "description": "Access mode settings" + } + }, + "required": [ + "accessModeSettings" + ] + }, + "AccessModeSettings": { + "type": "object", + "description": "Properties that define the scope private link mode settings.", + "properties": { + "queryAccessMode": { + "description": "Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.", + "$ref": "#/definitions/AccessMode" + }, + "ingestionAccessMode": { + "description": "Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.", + "$ref": "#/definitions/AccessMode" + }, + "exclusions": { + "description": "List of exclusions that override the default access mode settings for specific private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/AccessModeSettingsExclusion" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "queryAccessMode", + "ingestionAccessMode" + ] + }, + "AccessModeSettingsExclusion": { + "type": "object", + "description": "Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.", + "properties": { + "privateEndpointConnectionName": { + "description": "The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.", + "type": "string" + }, + "queryAccessMode": { + "description": "Specifies the access mode of queries through the specified private endpoint connection in the exclusion.", + "$ref": "#/definitions/AccessMode" + }, + "ingestionAccessMode": { + "description": "Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.", + "$ref": "#/definitions/AccessMode" + } + } + }, + "AccessMode": { + "description": "Access mode types.", + "type": "string", + "enum": [ + "Open", + "PrivateOnly" + ], + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + }, + "AzureMonitorPrivateLinkScopeListResult": { + "description": "Describes the list of Azure Monitor PrivateLinkScope resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Azure Monitor PrivateLinkScope definitions.", + "items": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Azure Monitor PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." + } + } + }, + "ScopedResourceListResult": { + "description": "A list of scoped resources in a private link scope.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ScopedResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ScopedResource": { + "description": "A private link scoped resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ScopedResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System data", + "readOnly": true + } + } + }, + "ScopedResourceProperties": { + "description": "Properties of a private link scoped resource.", + "type": "object", + "properties": { + "kind": { + "description": "The kind of scoped Azure monitor resource.", + "type": "string", + "enum": [ + "Resource", + "Metrics" + ], + "x-ms-enum": { + "name": "ScopedResourceKind", + "modelAsString": true + } + }, + "linkedResourceId": { + "description": "The resource id of the scoped Azure monitor resource.", + "type": "string" + }, + "subscriptionLocation": { + "description": "The location of a scoped subscription. Only needs to be specified for metric dataplane subscriptions.", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "State of the Azure monitor resource.", + "readOnly": true, + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ScopedResourceProvisioningState", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "PrivateLinkScopeName": { + "name": "scopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Monitor PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.go.md b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.go.md new file mode 100644 index 000000000000..efb7f14fecb4 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/monitor/privatelinkscopes +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` \ No newline at end of file diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.md b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.md new file mode 100644 index 000000000000..ae2c08b0c884 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/readme.md @@ -0,0 +1,112 @@ +# MonitorClient + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for MonitorClient. + +--- + +## Getting Started + +To build the SDK for MonitorClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the MonitorClient API. + +```yaml !$(python) || !$(track2) +title: MonitorClient +``` + +```yaml +description: Monitor Management Client +openapi-type: arm +openapi-subtype: rpaas +tag: package-preview-2021-09-01 +``` + +### Tag: package-2023-06-01-preview + +These settings apply only when `--tag=package-2023-06-01-preview` is specified on the command line + +``` yaml $(tag) == 'package-2023-06-01-preview' +input-file: +- preview\2023-06-01-preview\privateLinkScopes_API.json +``` + +### Tag: package-2021-09-01 + +These settings apply only when `--tag=package-2021-09-01` is specified on the command line + +``` yaml $(tag) == 'package-2021-09-01' +input-file: +- stable\2021-09-01\privateLinkScopes_API.json +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +# Validation + +## Suppression + +```yaml +directive: + - suppress: R4009 + from: privateLinkScopes_API.json + reason: "Contract is defined in the Network RP private endpoint spec, can be updated by internal calls from Network RP. " + - suppress: R3018 + from: privateLinkScopes_API.json + where: $.definitions.PrivateEndpointConnectionProperties.properties.queryOnlyPrivateLinkResources + reason: "This property indicates whether data coming through this private endpoint should restrict itself only to resources in the scope - it has only ''true'' or ''false'' options, so it fits boolean type." + - suppress: R3018 + from: privateLinkScopes_API.json + where: $.definitions.PrivateEndpointConnectionProperties.properties.ingestOnlyToPrivateLinkResources + reason: "This property indicates whether data coming through this private endpoint should restrict itself only to resources in the scope - it has only ''true'' or ''false'' options, so it fits boolean type." + - suppress: GetCollectionOnlyHasValueAndNextLink + from: privateLinkScopes_API.json + reason: "Updating the model would be a breaking change." + - suppress: XmsPageableForListCalls + from: privateLinkScopes_API.json + reason: "List scoped resources does not support pagination" + - suppress: ProvisioningStateSpecifiedForLROPut + from: privateLinkScopes_API.json + reason: "This was based on older guidance for structuring long-running operations. Changing the contract would be a breaking change." + - suppress: PutResponseCodes + from: privateLinkScopes_API.json + reason: "This was based on older guidance for structuring long-running operations. Changing the contract would be a breaking change." + - suppress: DeleteResponseCodes + from: privateLinkScopes_API.json + reason: "This was based on older guidance for structuring long-running operations. Changing the contract would be a breaking change." + - suppress: BodyTopLevelProperties + from: privateLinkScopes_API.json + reason: "This was based on older guidance for structuring long-running operations. Changing the contract would be a breaking change." + - suppress: OperationsAPIImplementation + where: $.paths + from: privateLinkScopes_API.json + reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' + - suppress: ResourceNameRestriction + from: privateLinkScopes_API.json + reason: 'Updating the resource name restriction would be a breaking change.' + - suppress: OperationsAPIImplementation + from: privateLinkScopes_API.json + reason: 'Operations API is defined in a separate swagger spec for Microsoft.Insights namespace (https://github.com/Azure/azure-rest-api-specs/blob/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json)' \ No newline at end of file diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionDelete.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..2708737efe0d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + }, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..770b9efe6fe5 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionList.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..c27d11f451ff --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2021-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name-2", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection.", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionUpdate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..85e8b966fd2c --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2021-09-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.Insights/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceGet.json new file mode 100644 index 000000000000..3cbc94fd43aa --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2021-09-01", + "groupName": "azuremonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateLinkResources/azuremonitor", + "name": "azuremonitor", + "type": "Microsoft.Insights/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "azuremonitor", + "requiredMembers": [ + "api", + "global.in.ai", + "profiler", + "live", + "snapshot", + "agentsolutionpackstore", + "dce-global" + ], + "requiredZoneNames": [ + "privatelink.monitor.azure.com", + "privatelink.oms.opinsights.azure.com", + "privatelink.ods.opinsights.azure.com", + "privatelink.agentsvc.azure-automation.net", + "privatelink.blob.core.windows.net" + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceListGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceListGet.json new file mode 100644 index 000000000000..78aa34941087 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopePrivateLinkResourceListGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2021-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateLinkResources/azuremonitor", + "name": "azuremonitor", + "type": "Microsoft.Insights/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "azuremonitor", + "requiredMembers": [ + "api", + "global.in.ai", + "profiler", + "live", + "snapshot", + "agentsolutionpackstore", + "dce-global" + ], + "requiredZoneNames": [ + "privatelink.monitor.azure.com", + "privatelink.oms.opinsights.azure.com", + "privatelink.ods.opinsights.azure.com", + "privatelink.agentsvc.azure-automation.net", + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceDelete.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceDelete.json new file mode 100644 index 000000000000..797378a63674 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2021-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + }, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceGet.json new file mode 100644 index 000000000000..991dc014631d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2021-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceList.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceList.json new file mode 100644 index 000000000000..4efe2c1b0f04 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "api-version": "2021-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "linkedResourceId": "/subscriptions/00000000-0000-2222-3333-444444444444/resourceGroups/MyComponentResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/other-scoped-resource-name", + "name": "other-scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "linkedResourceId": "/subscriptions/00000000-3333-2222-5555-444444444444/resourceGroups/MyWorkspaceResourceGroup/providers/Microsoft.OperationalInsights/workspaces/my-workspace", + "provisioningState": "Provisioning" + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceUpdate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceUpdate.json new file mode 100644 index 000000000000..c4f2bfd44e73 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopedResourceUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "scopeName": "MyPrivateLinkScope", + "name": "scoped-resource-name", + "api-version": "2021-09-01", + "parameters": { + "properties": { + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/scopedResources/scoped-resource-name", + "name": "scoped-resource-name", + "type": "Microsoft.Insights/privateLinkScopes/scopedResources", + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "linkedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/components/my-component", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesCreate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesCreate.json new file mode 100644 index 000000000000..51712e272212 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesCreate.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "AzureMonitorPrivateLinkScopePayload": { + "location": "Global", + "properties": { + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesDelete.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesDelete.json new file mode 100644 index 000000000000..574b765d7df6 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesGet.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesGet.json new file mode 100644 index 000000000000..ed05209cce14 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesList.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesList.json new file mode 100644 index 000000000000..93f9047a9a1e --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesList.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-other-resource-group/providers/microsoft.insights/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesListByResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesListByResourceGroup.json new file mode 100644 index 000000000000..27cfbd6158ca --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": {}, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdate.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdate.json new file mode 100644 index 000000000000..e94be300d2d0 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "AzureMonitorPrivateLinkScopePayload": { + "location": "Global", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": { + "Tag1": "Value1" + }, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": { + "Tag1": "Value1" + }, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdateTagsOnly.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdateTagsOnly.json new file mode 100644 index 000000000000..ce8ca7e66d29 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/PrivateLinkScopesUpdateTagsOnly.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-09-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "PrivateLinkScopeTags": { + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.insights/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.Insights/privateLinkScopes", + "location": "Global", + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + }, + "systemData": { + "createdBy": "bobby@contoso.com", + "createdByType": "User", + "createdAt": "2021-06-16T12:59:57.051056Z", + "lastModifiedBy": "bobby@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-06-16T12:59:57.051056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "accessModeSettings": { + "queryAccessMode": "Open", + "ingestionAccessMode": "Open", + "exclusions": [] + } + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/privateLinkScopeOperationStatuses.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/privateLinkScopeOperationStatuses.json new file mode 100644 index 000000000000..6b2e4d425eaf --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/examples/privateLinkScopeOperationStatuses.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "MyResourceGroup", + "asyncOperationId": "713192d7-503f-477a-9cfe-4efc3ee2bd11", + "api-version": "2021-09-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/713192d7-503f-477a-9cfe-4efc3ee2bd11", + "name": "713192d7-503f-477a-9cfe-4efc3ee2bd11", + "startTime": "2017-01-01T13:13:13.933Z", + "endTime": "2017-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/privateLinkScopes_API.json b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/privateLinkScopes_API.json new file mode 100644 index 000000000000..3abb7845fafa --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/privateLinkScopes_API.json @@ -0,0 +1,1124 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "description": "Azure Monitor API reference for Private Links Scopes management.", + "version": "2021-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/privateLinkScopes": { + "get": { + "description": "Gets a list of all Azure Monitor PrivateLinkScopes within a subscription.", + "operationId": "PrivateLinkScopes_List", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Monitor PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScopeListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopesList.json": { + "$ref": "./examples/PrivateLinkScopesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes": { + "get": { + "description": "Gets a list of Azure Monitor PrivateLinkScopes within a resource group.", + "operationId": "PrivateLinkScopes_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Monitor PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScopeListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeListByResourceGroup": { + "$ref": "./examples/PrivateLinkScopesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}": { + "delete": { + "description": "Deletes a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "204": { + "description": "The specified PrivateLinkScope does not exist." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateLinkScopesDelete": { + "$ref": "./examples/PrivateLinkScopesDelete.json" + } + } + }, + "get": { + "description": "Returns a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "An Azure Monitor PrivateLinkScope definition.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/PrivateLinkScopesGet.json" + } + } + }, + "put": { + "description": "Creates (or updates) a Azure Monitor PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "PrivateLinkScopes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "AzureMonitorPrivateLinkScopePayload", + "description": "Properties that need to be specified to create or update a Azure Monitor PrivateLinkScope.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope is returned.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "201": { + "description": "Successful request when creating or updating a Azure Monitor PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeCreate": { + "$ref": "./examples/PrivateLinkScopesCreate.json" + }, + "PrivateLinkScopeUpdate": { + "$ref": "./examples/PrivateLinkScopesUpdate.json" + } + } + }, + "patch": { + "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "PrivateLinkScopes_UpdateTags", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "PrivateLinkScopeTags", + "description": "Updated tag information to set into the PrivateLinkScope instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Azure Monitor PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", + "schema": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeUpdateTagsOnly": { + "$ref": "./examples/PrivateLinkScopesUpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopeOperationStatuses/{asyncOperationId}": { + "get": { + "x-ms-examples": { + "Get specific operation status": { + "$ref": "./examples/privateLinkScopeOperationStatuses.json" + } + }, + "tags": [ + "asyncOperations" + ], + "operationId": "PrivateLinkScopeOperationStatus_Get", + "description": "Get the status of an azure asynchronous operation associated with a private link scope operation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "asyncOperationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id." + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Operation status.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkScopePrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted private endpoint connection." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a private link scope.", + "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a private link scope.": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources/{name}": { + "get": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Gets a scoped resource in a private link scope.", + "operationId": "PrivateLinkScopedResources_Get", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "name", + "in": "path", + "description": "The name of the scoped resource object.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a scoped resource in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private link scoped resource.": { + "$ref": "./examples/PrivateLinkScopedResourceGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Add an Azure monitor scoped resource in the private link scope.", + "operationId": "PrivateLinkScopedResources_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "name", + "in": "path", + "description": "The name of the scoped resource object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedResource" + } + } + ], + "responses": { + "200": { + "description": "Successfully create or updated a new azure monitor scoped resource in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResource" + } + }, + "201": { + "description": "Successfully created a new azure monitor scoped resource in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a scoped resource in a private link scope.": { + "$ref": "./examples/PrivateLinkScopedResourceUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Deletes an Azure monitor scoped resource with a given name.", + "operationId": "PrivateLinkScopedResources_Delete", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "name", + "in": "path", + "description": "The name of the scoped resource object.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted scoped resource." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Scoped resource does not exist." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a scoped resource with a given name.": { + "$ref": "./examples/PrivateLinkScopedResourceDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/privateLinkScopes/{scopeName}/scopedResources": { + "get": { + "tags": [ + "PrivateLinkScopedResources" + ], + "description": "Gets all scoped resources on a private link scope.", + "operationId": "PrivateLinkScopedResources_ListByPrivateLinkScope", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scoped resources in a private link scope.", + "schema": { + "$ref": "#/definitions/ScopedResourceListResult" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of scoped resources in a private link scope.": { + "$ref": "./examples/PrivateLinkScopedResourceList.json" + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "description": "The status of operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation Id." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "startTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "Start time of the job in standard ISO8601 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "x-nullable": true, + "description": "End time of the job in standard ISO8601 format." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "type": "object", + "description": "The error detail of the operation if any.", + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", + "x-nullable": true + } + } + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags", + "type": "object" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.", + "type": "object" + }, + "AzureMonitorPrivateLinkScope": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties that define a Azure Monitor PrivateLinkScope resource.", + "$ref": "#/definitions/AzureMonitorPrivateLinkScopeProperties" + }, + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System data", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "An Azure Monitor PrivateLinkScope definition.", + "type": "object" + }, + "AzureMonitorPrivateLinkScopeProperties": { + "description": "Properties that define a Azure Monitor PrivateLinkScope resource.", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", + "readOnly": true + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "accessModeSettings": { + "type": "object", + "$ref": "#/definitions/AccessModeSettings", + "description": "Access mode settings" + } + }, + "required": [ + "accessModeSettings" + ] + }, + "AccessModeSettings": { + "type": "object", + "description": "Properties that define the scope private link mode settings.", + "properties": { + "queryAccessMode": { + "description": "Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.", + "$ref": "#/definitions/AccessMode" + }, + "ingestionAccessMode": { + "description": "Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.", + "$ref": "#/definitions/AccessMode" + }, + "exclusions": { + "description": "List of exclusions that override the default access mode settings for specific private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/AccessModeSettingsExclusion" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "queryAccessMode", + "ingestionAccessMode" + ] + }, + "AccessModeSettingsExclusion": { + "type": "object", + "description": "Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.", + "properties": { + "privateEndpointConnectionName": { + "description": "The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.", + "type": "string" + }, + "queryAccessMode": { + "description": "Specifies the access mode of queries through the specified private endpoint connection in the exclusion.", + "$ref": "#/definitions/AccessMode" + }, + "ingestionAccessMode": { + "description": "Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.", + "$ref": "#/definitions/AccessMode" + } + } + }, + "AccessMode": { + "description": "Access mode types.", + "type": "string", + "enum": [ + "Open", + "PrivateOnly" + ], + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + }, + "AzureMonitorPrivateLinkScopeListResult": { + "description": "Describes the list of Azure Monitor PrivateLinkScope resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Azure Monitor PrivateLinkScope definitions.", + "items": { + "$ref": "#/definitions/AzureMonitorPrivateLinkScope" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Azure Monitor PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." + } + } + }, + "ScopedResourceListResult": { + "description": "A list of scoped resources in a private link scope.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ScopedResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ScopedResource": { + "description": "A private link scoped resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ScopedResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "System data", + "readOnly": true + } + } + }, + "ScopedResourceProperties": { + "description": "Properties of a private link scoped resource.", + "type": "object", + "properties": { + "linkedResourceId": { + "description": "The resource id of the scoped Azure monitor resource.", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "State of the Azure monitor resource.", + "readOnly": true, + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ScopedResourceProvisioningState", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "PrivateLinkScopeName": { + "name": "scopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Monitor PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/monitor/suppressions.yaml b/specification/monitor/suppressions.yaml new file mode 100644 index 000000000000..31166f1ef89e --- /dev/null +++ b/specification/monitor/suppressions.yaml @@ -0,0 +1,7 @@ +- tool: TypeSpecRequirement + path: resource-manager/Microsoft.Insights/PrivateLinkScopes/stable/2021-09-01/**/*.json + reason: This is a reorganization of existing API versions, not introducing new API versions. These are old Swagger docs before Typespec requirements were implemented. + +- tool: TypeSpecRequirement + path: resource-manager/Microsoft.Insights/PrivateLinkScopes/preview/2023-06-01-preview/**/*.json + reason: This is a reorganization of existing API versions, not introducing new API versions. These are old Swagger docs before Typespec requirements were implemented. \ No newline at end of file From 69ed27bcd2a067caeb6446768d71e064f74e4436 Mon Sep 17 00:00:00 2001 From: Josiah Vinson <88204686+jovinson-ms@users.noreply.github.com> Date: Thu, 23 Jan 2025 09:50:41 -0800 Subject: [PATCH 27/74] Remove preview version for Deid (#32285) Co-authored-by: Josiah Vinson --- .../HealthDataAIServices.DeidServices.json | 1335 ----------------- .../examples/CancelJob.json | 41 - .../examples/CreateJob.json | 75 - .../examples/Deidentify.json | 40 - .../examples/DeleteJob.json | 12 - .../2024-07-12-preview/examples/GetJob.json | 41 - .../examples/ListJobDocuments.json | 38 - .../2024-07-12-preview/examples/ListJobs.json | 47 - .../readme.md | 9 - 9 files changed, 1638 deletions(-) delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json delete mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json deleted file mode 100644 index d1beef623192..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json +++ /dev/null @@ -1,1335 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Health Data Services de-identification service", - "version": "2024-07-12-preview", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "https://{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "in": "path", - "description": "Url of your De-identification Service.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "AadToken": [ - "https://deid.azure.com/.default" - ] - } - ], - "securityDefinitions": { - "AadToken": { - "type": "oauth2", - "description": "The Azure Active Directory OAuth2 Flow", - "flow": "accessCode", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://deid.azure.com/.default": "" - }, - "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" - } - }, - "tags": [], - "paths": { - "/deid": { - "post": { - "operationId": "Deidentify", - "summary": "De-identify text.", - "description": "A remote procedure call (RPC) operation.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "body", - "in": "body", - "description": "Request body for de-identification operation.", - "required": true, - "schema": { - "$ref": "#/definitions/DeidentificationContent" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/DeidentificationResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "De-identify text.": { - "$ref": "./examples/Deidentify.json" - } - } - } - }, - "/jobs": { - "get": { - "operationId": "ListJobs", - "summary": "List de-identification jobs.", - "description": "Resource list operation template.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/PaginationByTokenQueryParameters.continuationToken" - }, - { - "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedDeidentificationJob" - }, - "headers": { - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "List de-identification jobs.": { - "$ref": "./examples/ListJobs.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/jobs/{name}": { - "get": { - "operationId": "GetJob", - "summary": "Get a de-identification job.", - "description": "Resource read operation template.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of a job.", - "required": true, - "type": "string", - "minLength": 3, - "maxLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" - }, - { - "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/DeidentificationJob" - }, - "headers": { - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Get a de-identification job.": { - "$ref": "./examples/GetJob.json" - } - } - }, - "put": { - "operationId": "CreateJob", - "summary": "Create a de-identification job.", - "description": "Long-running resource create or replace operation template.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of a job.", - "required": true, - "type": "string", - "minLength": 3, - "maxLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" - }, - { - "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" - }, - { - "name": "resource", - "in": "body", - "description": "The resource instance.", - "required": true, - "schema": { - "$ref": "#/definitions/DeidentificationJob" - } - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/DeidentificationJob" - }, - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - }, - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "201": { - "description": "The request has succeeded and a new resource has been created as a result.", - "schema": { - "$ref": "#/definitions/DeidentificationJob" - }, - "headers": { - "Operation-Location": { - "type": "string", - "format": "uri", - "description": "The location for monitoring the operation state." - }, - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Create a de-identification job.": { - "$ref": "./examples/CreateJob.json" - } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "original-uri" - }, - "x-ms-long-running-operation": true - }, - "delete": { - "operationId": "DeleteJob", - "summary": "Delete a de-identification job.", - "description": "Removes the record of the job from the service. Does not delete any documents.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of a job.", - "required": true, - "type": "string", - "minLength": 3, - "maxLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" - }, - { - "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" - } - ], - "responses": { - "204": { - "description": "There is no content to send for this request, but the headers may be useful. ", - "headers": { - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Delete a de-identification job.": { - "$ref": "./examples/DeleteJob.json" - } - } - } - }, - "/jobs/{name}:cancel": { - "post": { - "operationId": "CancelJob", - "summary": "Cancel a de-identification job.", - "description": "Cancels a job that is in progress. \n\nThe job will be marked as canceled and the service will stop processing the job. The service will not delete any documents that have already been processed.\n\nIf the job is already complete, this will have no effect. ", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of a job.", - "required": true, - "type": "string", - "minLength": 3, - "maxLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" - }, - { - "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/DeidentificationJob" - }, - "headers": { - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Cancel a de-identification job.": { - "$ref": "./examples/CancelJob.json" - } - } - } - }, - "/jobs/{name}/documents": { - "get": { - "operationId": "ListJobDocuments", - "summary": "List processed documents within a job.", - "description": "Resource list operation template.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "name", - "in": "path", - "description": "The name of a job.", - "required": true, - "type": "string", - "minLength": 3, - "maxLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" - }, - { - "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" - }, - { - "$ref": "#/parameters/PaginationByTokenQueryParameters.continuationToken" - }, - { - "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedDocumentDetails" - }, - "headers": { - "x-ms-client-request-id": { - "type": "string", - "format": "uuid", - "description": "An opaque, globally-unique, client-generated string identifier for the request." - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "List processed documents within a job.": { - "$ref": "./examples/ListJobDocuments.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Azure.Core.Foundations.Error": { - "type": "object", - "description": "The error object.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "message": { - "type": "string", - "description": "A human-readable representation of the error." - }, - "target": { - "type": "string", - "description": "The target of the error." - }, - "details": { - "type": "array", - "description": "An array of details about specific errors that led to this reported error.", - "items": { - "$ref": "#/definitions/Azure.Core.Foundations.Error" - }, - "x-ms-identifiers": [] - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "An object containing more specific information than the current object about the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "Azure.Core.Foundations.ErrorResponse": { - "type": "object", - "description": "A response containing error details.", - "properties": { - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "The error object." - } - }, - "required": [ - "error" - ] - }, - "Azure.Core.Foundations.InnerError": { - "type": "object", - "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", - "properties": { - "code": { - "type": "string", - "description": "One of a server-defined set of error codes." - }, - "innererror": { - "$ref": "#/definitions/Azure.Core.Foundations.InnerError", - "description": "Inner error." - } - } - }, - "Azure.Core.Foundations.OperationState": { - "type": "string", - "description": "Enum describing allowed operation states.", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "OperationState", - "modelAsString": true, - "values": [ - { - "name": "NotStarted", - "value": "NotStarted", - "description": "The operation has not started." - }, - { - "name": "Running", - "value": "Running", - "description": "The operation is in progress." - }, - { - "name": "Succeeded", - "value": "Succeeded", - "description": "The operation has completed successfully." - }, - { - "name": "Failed", - "value": "Failed", - "description": "The operation has failed." - }, - { - "name": "Canceled", - "value": "Canceled", - "description": "The operation has been canceled by the user." - } - ] - } - }, - "Azure.Core.eTag": { - "type": "string", - "description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.\nIt lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.\n\nIt is a string of ASCII characters placed between double quotes, like \"675af34563dc-tr34\"." - }, - "DeidentificationContent": { - "type": "object", - "description": "Request body for de-identification operation.", - "properties": { - "inputText": { - "type": "string", - "description": "Input text to de-identify.", - "maxLength": 100000 - }, - "operation": { - "type": "string", - "description": "Operation to perform on the input.", - "default": "Surrogate", - "enum": [ - "Redact", - "Surrogate", - "Tag" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": true, - "values": [ - { - "name": "Redact", - "value": "Redact", - "description": "Redact Operation will remove all entities of PHI and replace them with a placeholder value." - }, - { - "name": "Surrogate", - "value": "Surrogate", - "description": "Surrogation Operation will replace all entities of PHI with a surrogate value." - }, - { - "name": "Tag", - "value": "Tag", - "description": "Tag Operation will detect all entities of PHI, their type, and return their locations in the document." - } - ] - } - }, - "dataType": { - "type": "string", - "description": "Data type of the input.", - "default": "Plaintext", - "enum": [ - "Plaintext" - ], - "x-ms-enum": { - "name": "DocumentDataType", - "modelAsString": true, - "values": [ - { - "name": "Plaintext", - "value": "Plaintext", - "description": "Plain text data type." - } - ] - } - }, - "redactionFormat": { - "type": "string", - "description": "Format of the redacted output. Only valid when OperationType is \"Redact\".", - "maxLength": 16 - } - }, - "required": [ - "inputText" - ] - }, - "DeidentificationJob": { - "type": "object", - "description": "A job containing a batch of documents to de-identify.", - "properties": { - "name": { - "type": "string", - "description": "The name of a job.", - "minLength": 3, - "maxLength": 36, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$", - "readOnly": true - }, - "sourceLocation": { - "$ref": "#/definitions/SourceStorageLocation", - "description": "Storage location to perform the operation on." - }, - "targetLocation": { - "$ref": "#/definitions/TargetStorageLocation", - "description": "Target location to store output of operation." - }, - "operation": { - "type": "string", - "description": "Operation to perform on the input documents.", - "default": "Surrogate", - "enum": [ - "Redact", - "Surrogate", - "Tag" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": true, - "values": [ - { - "name": "Redact", - "value": "Redact", - "description": "Redact Operation will remove all entities of PHI and replace them with a placeholder value." - }, - { - "name": "Surrogate", - "value": "Surrogate", - "description": "Surrogation Operation will replace all entities of PHI with a surrogate value." - }, - { - "name": "Tag", - "value": "Tag", - "description": "Tag Operation will detect all entities of PHI, their type, and return their locations in the document." - } - ] - } - }, - "dataType": { - "type": "string", - "description": "Data type of the input documents.", - "default": "Plaintext", - "enum": [ - "Plaintext" - ], - "x-ms-enum": { - "name": "DocumentDataType", - "modelAsString": true, - "values": [ - { - "name": "Plaintext", - "value": "Plaintext", - "description": "Plain text data type." - } - ] - } - }, - "redactionFormat": { - "type": "string", - "description": "Format of the redacted output. Only valid when Operation is Redact.", - "minLength": 1, - "maxLength": 16 - }, - "status": { - "$ref": "#/definitions/JobStatus", - "description": "Current status of a job.", - "readOnly": true - }, - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "Error when job fails in it's entirety.", - "readOnly": true - }, - "lastUpdatedAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the job was completed.\n\nIf the job is canceled, this is the time when the job was canceled.\n\nIf the job failed, this is the time when the job failed.", - "readOnly": true - }, - "createdAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the job was created.", - "readOnly": true - }, - "startedAt": { - "type": "string", - "format": "date-time", - "description": "Date and time when the job was started.", - "readOnly": true - }, - "summary": { - "$ref": "#/definitions/JobSummary", - "description": "Summary of a job. Exists only when the job is completed.", - "readOnly": true - } - }, - "required": [ - "name", - "sourceLocation", - "targetLocation", - "status", - "lastUpdatedAt", - "createdAt" - ] - }, - "DeidentificationResult": { - "type": "object", - "description": "Response body for de-identification operation.", - "properties": { - "outputText": { - "type": "string", - "description": "Output text after de-identification. Not available for \"Tag\" operation." - }, - "taggerResult": { - "$ref": "#/definitions/PhiTaggerResult", - "description": "Result of the \"Tag\" operation. Only available for \"Tag\" Operation." - } - } - }, - "DocumentDetails": { - "type": "object", - "description": "Details of a single document in a job.", - "properties": { - "id": { - "type": "string", - "description": "Id of the document details.", - "readOnly": true - }, - "input": { - "$ref": "#/definitions/DocumentLocation", - "description": "Location for the input." - }, - "output": { - "$ref": "#/definitions/DocumentLocation", - "description": "Location for the output." - }, - "status": { - "$ref": "#/definitions/Azure.Core.Foundations.OperationState", - "description": "Status of the document." - }, - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "Error when document fails." - } - }, - "required": [ - "id", - "input", - "status" - ] - }, - "DocumentLocation": { - "type": "object", - "description": "Location of a document.", - "properties": { - "path": { - "type": "string", - "description": "Path of document in storage.", - "maxLength": 1024 - }, - "etag": { - "$ref": "#/definitions/Azure.Core.eTag", - "description": "The entity tag for this resource.", - "readOnly": true - } - }, - "required": [ - "path", - "etag" - ] - }, - "JobStatus": { - "type": "string", - "description": "List of statuses a job can have.", - "enum": [ - "NotStarted", - "Running", - "Succeeded", - "PartialFailed", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true, - "values": [ - { - "name": "NotStarted", - "value": "NotStarted", - "description": "Job has been submitted and is waiting to be processed." - }, - { - "name": "Running", - "value": "Running", - "description": "Job has been started." - }, - { - "name": "Succeeded", - "value": "Succeeded", - "description": "Job has completed successfully. All documents have succeeded." - }, - { - "name": "PartialFailed", - "value": "PartialFailed", - "description": "Job has completed with at least a single document failing." - }, - { - "name": "Failed", - "value": "Failed", - "description": "Job has completed with all documents failing, or a validation failure." - }, - { - "name": "Canceled", - "value": "Canceled", - "description": "Job has been canceled after user request." - } - ] - } - }, - "JobSummary": { - "type": "object", - "description": "Summary metrics of a job.", - "properties": { - "successful": { - "type": "integer", - "format": "int32", - "description": "Number of documents that have completed." - }, - "failed": { - "type": "integer", - "format": "int32", - "description": "Number of documents that have failed." - }, - "canceled": { - "type": "integer", - "format": "int32", - "description": "Number of documents that have been canceled." - }, - "total": { - "type": "integer", - "format": "int32", - "description": "Number of documents total." - }, - "bytesProcessed": { - "type": "integer", - "format": "int64", - "description": "Number of bytes processed." - } - }, - "required": [ - "successful", - "failed", - "canceled", - "total", - "bytesProcessed" - ] - }, - "PagedDeidentificationJob": { - "type": "object", - "description": "Paged collection of DeidentificationJob items", - "properties": { - "value": { - "type": "array", - "description": "The DeidentificationJob items on this page", - "items": { - "$ref": "#/definitions/DeidentificationJob" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PagedDocumentDetails": { - "type": "object", - "description": "Paged collection of DocumentDetails items", - "properties": { - "value": { - "type": "array", - "description": "The DocumentDetails items on this page", - "items": { - "$ref": "#/definitions/DocumentDetails" - } - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "PhiCategory": { - "type": "string", - "description": "List of PHI Entities.", - "enum": [ - "Unknown", - "Account", - "Age", - "BioID", - "City", - "CountryOrRegion", - "Date", - "Device", - "Doctor", - "Email", - "Fax", - "HealthPlan", - "Hospital", - "IDNum", - "IPAddress", - "License", - "LocationOther", - "MedicalRecord", - "Organization", - "Patient", - "Phone", - "Profession", - "SocialSecurity", - "State", - "Street", - "Url", - "Username", - "Vehicle", - "Zip" - ], - "x-ms-enum": { - "name": "PhiCategory", - "modelAsString": true, - "values": [ - { - "name": "Unknown", - "value": "Unknown", - "description": "Unknown PHI Type." - }, - { - "name": "Account", - "value": "Account", - "description": "Account Number." - }, - { - "name": "Age", - "value": "Age", - "description": "Age." - }, - { - "name": "BioID", - "value": "BioID", - "description": "Biological Identifier, such as a fingerprint or retinal scan." - }, - { - "name": "City", - "value": "City", - "description": "City." - }, - { - "name": "CountryOrRegion", - "value": "CountryOrRegion", - "description": "Country or Region." - }, - { - "name": "Date", - "value": "Date", - "description": "Date." - }, - { - "name": "Device", - "value": "Device", - "description": "Device ID or serial numbers." - }, - { - "name": "Doctor", - "value": "Doctor", - "description": "Doctor's Name." - }, - { - "name": "Email", - "value": "Email", - "description": "Email Addresses." - }, - { - "name": "Fax", - "value": "Fax", - "description": "Fax Number." - }, - { - "name": "HealthPlan", - "value": "HealthPlan", - "description": "Health Plan ID Numbers." - }, - { - "name": "Hospital", - "value": "Hospital", - "description": "Hospital Name." - }, - { - "name": "IDNum", - "value": "IDNum", - "description": "Id Number, eg. passport number." - }, - { - "name": "IPAddress", - "value": "IPAddress", - "description": "IP Address." - }, - { - "name": "License", - "value": "License", - "description": "License, eg. Driver's license or medical license." - }, - { - "name": "LocationOther", - "value": "LocationOther", - "description": "Location Other, eg. Golden Gate Park." - }, - { - "name": "MedicalRecord", - "value": "MedicalRecord", - "description": "Medical Record Number." - }, - { - "name": "Organization", - "value": "Organization", - "description": "Organization, eg. Microsoft." - }, - { - "name": "Patient", - "value": "Patient", - "description": "Patient Name." - }, - { - "name": "Phone", - "value": "Phone", - "description": "Phone Number." - }, - { - "name": "Profession", - "value": "Profession", - "description": "Profession." - }, - { - "name": "SocialSecurity", - "value": "SocialSecurity", - "description": "Social Security Number." - }, - { - "name": "State", - "value": "State", - "description": "State." - }, - { - "name": "Street", - "value": "Street", - "description": "Street." - }, - { - "name": "Url", - "value": "Url", - "description": "Web URL." - }, - { - "name": "Username", - "value": "Username", - "description": "Usernames, eg. a social media handle." - }, - { - "name": "Vehicle", - "value": "Vehicle", - "description": "Vehicle IDs, eg. license plate or VIN number." - }, - { - "name": "Zip", - "value": "Zip", - "description": "Zip Code." - } - ] - } - }, - "PhiEntity": { - "type": "object", - "description": "PHI Entity tag in the input.", - "properties": { - "category": { - "$ref": "#/definitions/PhiCategory", - "description": "PHI Category of the entity." - }, - "offset": { - "$ref": "#/definitions/StringIndex", - "description": "Starting index of the location from within the input text." - }, - "length": { - "$ref": "#/definitions/StringIndex", - "description": "Length of the input text." - }, - "text": { - "type": "string", - "description": "Text of the entity." - }, - "confidenceScore": { - "type": "number", - "format": "double", - "description": "Confidence score of the category match." - } - }, - "required": [ - "category", - "offset", - "length" - ] - }, - "PhiTaggerResult": { - "type": "object", - "description": "Result of the \"Tag\" operation.", - "properties": { - "entities": { - "type": "array", - "description": "List of entities detected in the input.", - "items": { - "$ref": "#/definitions/PhiEntity" - }, - "x-ms-identifiers": [] - }, - "path": { - "type": "string", - "description": "Path to the document in storage.", - "maxLength": 1024 - }, - "etag": { - "$ref": "#/definitions/Azure.Core.eTag", - "description": "The entity tag for this resource." - } - }, - "required": [ - "entities" - ] - }, - "SourceStorageLocation": { - "type": "object", - "description": "Storage location.", - "properties": { - "location": { - "type": "string", - "format": "uri", - "description": "URL to storage location." - }, - "prefix": { - "type": "string", - "description": "Prefix to filter path by.", - "minLength": 1, - "maxLength": 1024 - }, - "extensions": { - "type": "array", - "description": "List of extensions to filter path by.", - "default": [ - "*" - ], - "minItems": 1, - "items": { - "type": "string" - } - } - }, - "required": [ - "location", - "prefix" - ] - }, - "StringIndex": { - "type": "object", - "description": "String index encoding model.", - "properties": { - "utf8": { - "type": "integer", - "format": "int32", - "description": "The offset or length of the substring in UTF-8 encoding" - }, - "utf16": { - "type": "integer", - "format": "int32", - "description": "The offset or length of the substring in UTF-16 encoding.\n\nPrimary encoding used by .NET, Java, and JavaScript." - }, - "codePoint": { - "type": "integer", - "format": "int32", - "description": "The offset or length of the substring in CodePoint encoding.\n\nPrimary encoding used by Python." - } - }, - "required": [ - "utf8", - "utf16", - "codePoint" - ] - }, - "TargetStorageLocation": { - "type": "object", - "description": "Storage location.", - "properties": { - "location": { - "type": "string", - "format": "uri", - "description": "URL to storage location." - }, - "prefix": { - "type": "string", - "description": "Prefix to filter path by.", - "minLength": 1, - "maxLength": 1024 - } - }, - "required": [ - "location", - "prefix" - ] - } - }, - "parameters": { - "Azure.Core.ClientRequestIdHeader": { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-parameter-location": "method", - "x-ms-client-name": "clientRequestId" - }, - "Azure.Core.Foundations.ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for this operation.", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "x-ms-client-name": "apiVersion" - }, - "Azure.Core.MaxPageSizeQueryParameter": { - "name": "maxpagesize", - "in": "query", - "description": "The maximum number of result items per page.", - "required": false, - "type": "integer", - "format": "int32", - "x-ms-parameter-location": "method" - }, - "PaginationByTokenQueryParameters.continuationToken": { - "name": "continuationToken", - "in": "query", - "description": "Token to continue a previous query.", - "required": false, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json deleted file mode 100644 index c70063471c24..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "title": "Cancel a de-identification job.", - "operationId": "CancelJob", - "parameters": { - "api-version": "2024-07-12-preview", - "name": "documents_smith_1", - "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "name": "documents_smith_1", - "sourceLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents", - "extensions": [ - "*" - ] - }, - "targetLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents" - }, - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]", - "status": "Canceled", - "lastUpdatedAt": "2024-01-26T01:15:00.009Z", - "createdAt": "2024-01-25T23:27:43.009Z", - "startedAt": "2024-01-25T23:27:43.009Z", - "summary": { - "successful": 10, - "failed": 0, - "canceled": 2, - "total": 12, - "bytesProcessed": 4096 - } - } - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json deleted file mode 100644 index 87689147cfcf..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "title": "Create a de-identification job.", - "operationId": "CreateJob", - "parameters": { - "api-version": "2024-07-12-preview", - "name": "documents_smith_1", - "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", - "resource": { - "sourceLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents", - "extensions": [ - "*" - ] - }, - "targetLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents" - }, - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]", - "status": "NotStarted" - } - }, - "responses": { - "200": { - "body": { - "name": "documents_smith_1", - "sourceLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents", - "extensions": [ - "*" - ] - }, - "targetLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents" - }, - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]", - "status": "NotStarted", - "lastUpdatedAt": "2024-01-26T01:15:00.009Z", - "createdAt": "2024-01-25T23:27:43.009Z" - } - }, - "201": { - "headers": { - "original-uri": "https://contoso.com/operationstatus" - }, - "body": { - "name": "documents_smith_1", - "sourceLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents", - "extensions": [ - "*" - ] - }, - "targetLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents" - }, - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]", - "status": "NotStarted", - "lastUpdatedAt": "2024-01-26T01:15:00.009Z", - "createdAt": "2024-01-25T23:27:43.009Z" - } - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json deleted file mode 100644 index e2021314bf20..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "title": "De-identify text.", - "operationId": "Deidentify", - "parameters": { - "api-version": "2024-07-12-preview", - "body": { - "inputText": "Hello my name is John Smith.", - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]" - } - }, - "responses": { - "200": { - "body": { - "outputText": "Hello my name is [name].", - "taggerResult": { - "entities": [ - { - "category": "Patient", - "offset": { - "utf8": 17, - "utf16": 17, - "codePoint": 17 - }, - "length": { - "utf8": 10, - "utf16": 10, - "codePoint": 10 - }, - "text": "John Smith", - "confidenceScore": 0.83 - } - ], - "etag": "0x000000000000000" - } - } - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json deleted file mode 100644 index 9b49028db92a..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "title": "Delete a de-identification job.", - "operationId": "DeleteJob", - "parameters": { - "api-version": "2024-07-12-preview", - "name": "documents_smith_1", - "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "204": {} - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json deleted file mode 100644 index 41496ff69046..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "title": "Get a de-identification job.", - "operationId": "GetJob", - "parameters": { - "api-version": "2024-07-12-preview", - "name": "documents_smith_1", - "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "name": "documents_smith_1", - "sourceLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents", - "extensions": [ - "*" - ] - }, - "targetLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents" - }, - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]", - "status": "Succeeded", - "lastUpdatedAt": "2024-01-26T01:15:00.009Z", - "createdAt": "2024-01-25T23:27:43.009Z", - "startedAt": "2024-01-25T23:27:43.009Z", - "summary": { - "successful": 10, - "failed": 0, - "canceled": 0, - "total": 10, - "bytesProcessed": 4096 - } - } - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json deleted file mode 100644 index 372911afab67..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "title": "List processed documents within a job.", - "operationId": "ListJobDocuments", - "parameters": { - "api-version": "2024-07-12-preview", - "name": "documents_smith_1", - "maxpagesize": 10, - "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==", - "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "00000000-0000-0000-0000-000000000000", - "input": { - "path": "/documents/patient_doc_1", - "etag": "0x8DB638EEA0CC717" - }, - "output": { - "path": "_output/documents/patient_doc_1", - "etag": "0xAB298APO23099ZL" - }, - "status": "Failed", - "error": { - "code": "FileNotFound", - "message": "File was moved after job started.", - "target": "SourceFile", - "details": [] - } - } - ], - "nextLink": "https://deidtest.api.deid.azure.com/jobs/00000000-0000-0000-0000-000000000000/files?top=10&skip=10&maxpagesize=10" - } - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json deleted file mode 100644 index 43061dc58040..000000000000 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "title": "List de-identification jobs.", - "operationId": "ListJobs", - "parameters": { - "api-version": "2024-07-12-preview", - "maxpagesize": 10, - "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==", - "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "documents_smith_1", - "sourceLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents", - "extensions": [ - "*" - ] - }, - "targetLocation": { - "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D", - "prefix": "/documents" - }, - "operation": "Redact", - "dataType": "Plaintext", - "redactionFormat": "[{type}]", - "status": "Succeeded", - "lastUpdatedAt": "2024-01-26T01:15:00.009Z", - "createdAt": "2024-01-25T23:27:43.009Z", - "startedAt": "2024-01-25T23:27:43.009Z", - "summary": { - "successful": 10, - "failed": 0, - "canceled": 0, - "total": 10, - "bytesProcessed": 4096 - } - } - ], - "nextLink": "https://deidtest.api.deid.azure.com/jobs?top=10&skip=10&maxpagesize=10" - } - } - } -} diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md index 4f7aec4bdb1f..883a2262edbb 100644 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md @@ -42,15 +42,6 @@ input-file: - stable/2024-11-15/HealthDataAIServices.DeidServices.json ``` -### Tag: package-2024-07-12-preview - -These settings apply only when `--tag=package-2024-07-12-preview` is specified on the command line. - -```yaml $(tag) == 'package-2024-07-12-preview' -input-file: - - preview/2024-07-12-preview/HealthDataAIServices.DeidServices.json -``` - --- # Code Generation From 91fad07b9d7480cf1f49e387bd6be627c1aec0b5 Mon Sep 17 00:00:00 2001 From: parthmiglani-microsoft Date: Fri, 24 Jan 2025 00:29:19 +0530 Subject: [PATCH 28/74] Changed datamap endpoint from string to url (#32276) * changed datamap edndpoint * regenerated file --------- Co-authored-by: Krista Pratico --- .../purview/Azure.Analytics.Purview.DataMap/main.tsp | 2 +- .../stable/2023-09-01/purviewdatamap.json | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp index bec1c82a4957..bb3c4c1f430f 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp +++ b/specification/purview/Azure.Analytics.Purview.DataMap/main.tsp @@ -13,7 +13,7 @@ using TypeSpec.Versioning; "{endpoint}/datamap/api", "Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Map helps organizations get more value from their existing investments.", { - endpoint: string, + endpoint: url, } ) @doc(""" diff --git a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json index 4acce1bf0f2f..bdfe79cbe686 100644 --- a/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json +++ b/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json @@ -21,7 +21,9 @@ "name": "endpoint", "in": "path", "required": true, - "type": "string" + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true } ] }, From 63d36000794ed89006cda8588861a2ae7ed96bdc Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Thu, 23 Jan 2025 16:45:03 -0800 Subject: [PATCH 29/74] support spec PR trigger (#32309) Co-authored-by: ray chen --- .../templates/jobs/archetype-spec-gen-sdk.yml | 35 ++++++++++++------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml b/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml index 30722e8df7fb..1b4d3376be89 100644 --- a/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml +++ b/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml @@ -5,7 +5,7 @@ parameters: type: string - name: SpecRepoCommit type: string - default: 'HEAD' + default: '$(Build.SourceBranch)' - name: SdkRepoCommit type: string default: 'HEAD' @@ -47,6 +47,15 @@ jobs: - checkout: none - pwsh: | + $tspConfigPathPattern = '^specification\/([^\/]+\/)+tspconfig\.yaml$' + $readmePathPattern = '^specification\/([^\/]+\/){2,}readme\.md$' + if (('${{ parameters.ConfigType }}' -eq 'TypeSpec') -and ('${{ parameters.ConfigPath }}' -notmatch $tspConfigPathPattern)) { + Write-Host "##vso[task.logissue type=error]'ConfigPath' must be a valid 'tspconfig.yaml' file path when 'ConfigType' is set to 'TypeSpec'. For example, 'specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml'" + Exit 1 + } elseif (('${{ parameters.ConfigType }}' -eq 'OpenAPI') -and ('${{ parameters.ConfigPath }}' -notmatch $readmePathPattern)) { + Write-Host "##vso[task.logissue type=error]'ConfigPath' must be a valid 'readme.md' file path when 'ConfigType' is set to 'OpenAPI'. For example, 'specification/appplatform/resource-manager/readme.md'" + Exit 1 + } $urlPattern = '^https://github\.com/(?[^/]+)/(?[^/]+)' if ('${{ parameters.SpecRepoUrl }}' -match $urlPattern) { $specRepoOwner = $Matches['organization'] @@ -64,11 +73,11 @@ jobs: if ('${{ parameters.SdkRepoUrl }}' -match $urlPattern) { if ('${{ parameters.SpecRepoUrl }}'.EndsWith('-pr') -and (-not '${{ parameters.SdkRepoUrl }}'.EndsWith('-pr'))) { - Write-Host "SdkRepoUrl must be a private repository if SpecRepoUrl is a private repository." + Write-Host "##vso[task.logissue type=error]SdkRepoUrl must be a private repository if SpecRepoUrl is a private repository." Exit 1 } - $sdkRepoOwner = if ('$(SdkRepoOwner)' -eq '') { $Matches['organization'] } else { '$(SdkRepoOwner)' } + $sdkRepoOwner = $Matches['organization'] Write-Host "##vso[task.setvariable variable=SdkRepoOwner]$sdkRepoOwner" Write-Host "SdkRepoOwner variable set to: $sdkRepoOwner" @@ -82,16 +91,10 @@ jobs: } if ([string]::IsNullOrEmpty($SpecRepoOwner) -or [string]::IsNullOrEmpty($SpecRepoName) -or [string]::IsNullOrEmpty($SdkRepoOwner) -or [string]::IsNullOrEmpty($SdkRepoName)) { - Write-Host "One or more required variables is empty or invalid. Ensure that SpecRepourl and SdkRepoUrl are set to valid GitHub repository URLs." + Write-Host "##vso[task.logissue type=error]One or more required variables is empty or invalid. Ensure that SpecRepoUrl and SdkRepoUrl are set to valid GitHub repository URLs." Exit 1 } - $sdkRepoNameForSpecGen = $sdkRepoName - if ($sdkRepoName.EndsWith('-for-net')) { - $sdkRepoNameForSpecGen = $sdkRepoName + "-track2" - } - Write-Host "##vso[task.setvariable variable=SdkRepoNameForSpecGen]$sdkRepoNameForSpecGen" - Write-Host "SdkRepoNameForSpecGen variable set to: $sdkRepoNameForSpecGen" displayName: "Create Run Time Variables" - template: /eng/common/pipelines/templates/steps/sparse-checkout.yml @@ -112,7 +115,7 @@ jobs: SkipCheckoutNone: true - script: | - if [ "${{ parameters.SpecRepoCommit }}" = "HEAD" ]; then + if [ "${{ parameters.SpecRepoCommit }}" = "$(Build.SourceBranch)" ]; then cd $(SpecRepoDirectory) default_commit=$(git rev-parse HEAD) echo "##vso[task.setvariable variable=SpecRepoCommit]$default_commit" @@ -148,6 +151,12 @@ jobs: sdk_gen_info="$sdk_gen_info '${{ parameters.ConfigPath }}'," fi + if [ "$(Build.Reason)" = "PullRequest" ]; then + optional_params="$optional_params --n=$(System.PullRequest.PullRequestNumber)" + specPrUrl="${{ parameters.SpecRepoUrl }}/pull/$(System.PullRequest.PullRequestNumber)" + sdk_gen_info="$sdk_gen_info spec PR: $specPrUrl" + fi + sdk_gen_info="$sdk_gen_info and CommitSHA: '$(SpecRepoCommit)', in SpecRepo: '${{ parameters.SpecRepoUrl }}'" echo "##vso[task.setvariable variable=GeneratedSDKInformation]$sdk_gen_info" echo "Generated SDK Information : $sdk_gen_info" @@ -156,7 +165,7 @@ jobs: --scp "$(SpecRepoDirectory)" \ --sdp "$(SdkRepoDirectory)" \ --wf "$(System.DefaultWorkingDirectory)" \ - -l "$(SdkRepoNameForSpecGen)" \ + -l "$(SdkRepoName)" \ -c "$(SpecRepoCommit)" \ -t $true \ $optional_params @@ -210,7 +219,7 @@ jobs: - task: PowerShell@2 displayName: Create pull request - condition: and(succeeded(), eq(variables['HasChanges'], 'true')) + condition: and(succeeded(), eq(variables['HasChanges'], 'true'), ne(variables['Build.Reason'], 'PullRequest')) inputs: pwsh: true workingDirectory: $(SdkRepoDirectory) From b8adce17dc500f338f86f18af30aac61dcb71c5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?McCoy=20Pati=C3=B1o?= <39780829+mccoyp@users.noreply.github.com> Date: Thu, 23 Jan 2025 18:20:21 -0800 Subject: [PATCH 30/74] [Key Vault] Add warnings to RSA_1_5 and RSA-OAEP documentation (#32289) --- .../Security.KeyVault.Keys/examples/7.5/wrapKey-example.json | 4 ++-- .../examples/7.6-preview.1/wrapKey-example.json | 4 ++-- specification/keyvault/Security.KeyVault.Keys/models.tsp | 4 ++-- .../preview/7.6-preview.1/examples/wrapKey-example.json | 4 ++-- .../Microsoft.KeyVault/preview/7.6-preview.1/keys.json | 4 ++-- .../stable/7.5/examples/wrapKey-example.json | 4 ++-- .../data-plane/Microsoft.KeyVault/stable/7.5/keys.json | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/specification/keyvault/Security.KeyVault.Keys/examples/7.5/wrapKey-example.json b/specification/keyvault/Security.KeyVault.Keys/examples/7.5/wrapKey-example.json index 04e7fd4ce67e..c10eb950290a 100644 --- a/specification/keyvault/Security.KeyVault.Keys/examples/7.5/wrapKey-example.json +++ b/specification/keyvault/Security.KeyVault.Keys/examples/7.5/wrapKey-example.json @@ -5,7 +5,7 @@ "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", "api-version": "7.5", "parameters": { - "alg": "RSA1_5", + "alg": "RSA-OAEP-256", "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" } }, @@ -13,7 +13,7 @@ "200": { "body": { "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", - "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + "value": "jdweWJO8dmKw4feBggZGyiMcgTnxS6QycpTSKEZd9VV9munW+STSr45GimVdOXbBowArlrUDGUhrCa7Z1vv4HgwOPhKomDNSAgqt0t/TgPiIVWSN+cMcARj0Y8/hrZVzlu+IlWBv/MVyPoytASyH8eF1L3UQa4Xh8Ebpjvs9yAZsr9tWG2Q1sn4jKetRBJHz44IV4g2rTgut+rZHK9ubdNB91nzqoRuN162uQkKlC7tBuBASd53gOAeaxedTt1RuW7w56XzSx2k/60ehmBcNuLaYAds7g4e8qec1k+u6rc2scU4n+RHuZTvqXkwpEYUsAqKKn8G7wylSWjHszNUEUw" } } }, diff --git a/specification/keyvault/Security.KeyVault.Keys/examples/7.6-preview.1/wrapKey-example.json b/specification/keyvault/Security.KeyVault.Keys/examples/7.6-preview.1/wrapKey-example.json index aea5a3a92e25..46b4546f66b4 100644 --- a/specification/keyvault/Security.KeyVault.Keys/examples/7.6-preview.1/wrapKey-example.json +++ b/specification/keyvault/Security.KeyVault.Keys/examples/7.6-preview.1/wrapKey-example.json @@ -5,7 +5,7 @@ "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", "api-version": "7.6-preview.1", "parameters": { - "alg": "RSA1_5", + "alg": "RSA-OAEP-256", "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" } }, @@ -13,7 +13,7 @@ "200": { "body": { "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", - "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + "value": "jdweWJO8dmKw4feBggZGyiMcgTnxS6QycpTSKEZd9VV9munW+STSr45GimVdOXbBowArlrUDGUhrCa7Z1vv4HgwOPhKomDNSAgqt0t/TgPiIVWSN+cMcARj0Y8/hrZVzlu+IlWBv/MVyPoytASyH8eF1L3UQa4Xh8Ebpjvs9yAZsr9tWG2Q1sn4jKetRBJHz44IV4g2rTgut+rZHK9ubdNB91nzqoRuN162uQkKlC7tBuBASd53gOAeaxedTt1RuW7w56XzSx2k/60ehmBcNuLaYAds7g4e8qec1k+u6rc2scU4n+RHuZTvqXkwpEYUsAqKKn8G7wylSWjHszNUEUw" } } }, diff --git a/specification/keyvault/Security.KeyVault.Keys/models.tsp b/specification/keyvault/Security.KeyVault.Keys/models.tsp index 79adb4ee74f7..1229c5f7012f 100644 --- a/specification/keyvault/Security.KeyVault.Keys/models.tsp +++ b/specification/keyvault/Security.KeyVault.Keys/models.tsp @@ -146,7 +146,7 @@ union JsonWebKeyEncryptionAlgorithm { string, /** - * RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1. + * [Not recommended] RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_OAEP, which is included solely for backwards compatibility. RSA_OAEP utilizes SHA1, which has known collision problems. */ RSA_OAEP: "RSA-OAEP", @@ -155,7 +155,7 @@ union JsonWebKeyEncryptionAlgorithm { */ RSA_OAEP256: "RSA-OAEP-256", - /** RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447. */ + /** [Not recommended] RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_1_5, which is included solely for backwards compatibility. Cryptographic standards no longer consider RSA with the PKCS#1 v1.5 padding scheme secure for encryption. */ RSA1_5: "RSA1_5", /** 128-bit AES-GCM. */ diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/examples/wrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/examples/wrapKey-example.json index aea5a3a92e25..46b4546f66b4 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/examples/wrapKey-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/examples/wrapKey-example.json @@ -5,7 +5,7 @@ "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", "api-version": "7.6-preview.1", "parameters": { - "alg": "RSA1_5", + "alg": "RSA-OAEP-256", "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" } }, @@ -13,7 +13,7 @@ "200": { "body": { "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", - "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + "value": "jdweWJO8dmKw4feBggZGyiMcgTnxS6QycpTSKEZd9VV9munW+STSr45GimVdOXbBowArlrUDGUhrCa7Z1vv4HgwOPhKomDNSAgqt0t/TgPiIVWSN+cMcARj0Y8/hrZVzlu+IlWBv/MVyPoytASyH8eF1L3UQa4Xh8Ebpjvs9yAZsr9tWG2Q1sn4jKetRBJHz44IV4g2rTgut+rZHK9ubdNB91nzqoRuN162uQkKlC7tBuBASd53gOAeaxedTt1RuW7w56XzSx2k/60ehmBcNuLaYAds7g4e8qec1k+u6rc2scU4n+RHuZTvqXkwpEYUsAqKKn8G7wylSWjHszNUEUw" } } }, diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/keys.json index f861ee5a84be..1c7795a2c6c5 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.6-preview.1/keys.json @@ -1577,7 +1577,7 @@ { "name": "RSA_OAEP", "value": "RSA-OAEP", - "description": "RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1." + "description": "[Not recommended] RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_OAEP, which is included solely for backwards compatibility. RSA_OAEP utilizes SHA1, which has known collision problems." }, { "name": "RSA_OAEP256", @@ -1587,7 +1587,7 @@ { "name": "RSA1_5", "value": "RSA1_5", - "description": "RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447." + "description": "[Not recommended] RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_1_5, which is included solely for backwards compatibility. Cryptographic standards no longer consider RSA with the PKCS#1 v1.5 padding scheme secure for encryption." }, { "name": "A128_GCM", diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json index 04e7fd4ce67e..c10eb950290a 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/examples/wrapKey-example.json @@ -5,7 +5,7 @@ "key-version": "0698c2156c1a4e1da5b6bab6f6422fd6", "api-version": "7.5", "parameters": { - "alg": "RSA1_5", + "alg": "RSA-OAEP-256", "value": "ovQIlbB0DgWhZA7sgkPxbg9H-Ly-VlNGPSgGrrZvlIo" } }, @@ -13,7 +13,7 @@ "200": { "body": { "kid": "https://myvault.vault.azure.net/keys/sdktestkey/0698c2156c1a4e1da5b6bab6f6422fd6", - "value": "khwIe26NuAZazS7upywDBpGRmRNMW5-4h_JQKxOdB78nYVxZWnBXwCxOv7a3Sr_mCjiVzKsoQQZwL-CJzhYa0512tfYem56zls5a44y5QsdcfvuSzOvpthVhA9XkEfCJSqSY_sip5d8BelT_w_ikvd_8KqiQ_0H54RqYUN8svCpu28paHgBocHFNXTQ9NtU9ec2qgESXk7Jp4OTy9HJtQJavKDUqTJ3YmtLxUgsgBCe0FNMHUSEYC0Ys6PavYzdTwIzYCq84idmAxJOj-O_6eALJFH2sDTOQYHjzOae2t8eFmw6C-t55qjrCI91a9mUJEGPhYixiG4gR4PaEJ7wGvw" + "value": "jdweWJO8dmKw4feBggZGyiMcgTnxS6QycpTSKEZd9VV9munW+STSr45GimVdOXbBowArlrUDGUhrCa7Z1vv4HgwOPhKomDNSAgqt0t/TgPiIVWSN+cMcARj0Y8/hrZVzlu+IlWBv/MVyPoytASyH8eF1L3UQa4Xh8Ebpjvs9yAZsr9tWG2Q1sn4jKetRBJHz44IV4g2rTgut+rZHK9ubdNB91nzqoRuN162uQkKlC7tBuBASd53gOAeaxedTt1RuW7w56XzSx2k/60ehmBcNuLaYAds7g4e8qec1k+u6rc2scU4n+RHuZTvqXkwpEYUsAqKKn8G7wylSWjHszNUEUw" } } }, diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json index 13aaf35d233d..0b5da112a860 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.5/keys.json @@ -1575,7 +1575,7 @@ { "name": "RSA_OAEP", "value": "RSA-OAEP", - "description": "RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1." + "description": "[Not recommended] RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_OAEP, which is included solely for backwards compatibility. RSA_OAEP utilizes SHA1, which has known collision problems." }, { "name": "RSA_OAEP256", @@ -1585,7 +1585,7 @@ { "name": "RSA1_5", "value": "RSA1_5", - "description": "RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447." + "description": "[Not recommended] RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_1_5, which is included solely for backwards compatibility. Cryptographic standards no longer consider RSA with the PKCS#1 v1.5 padding scheme secure for encryption." }, { "name": "A128_GCM", From 6f6ff28362346bf0cbbe8affca9122cc9200c9e2 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Fri, 24 Jan 2025 11:24:28 +0800 Subject: [PATCH 31/74] Create client.tsp (#32296) --- .../databasewatcher/DatabaseWatcher.Management/client.tsp | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 specification/databasewatcher/DatabaseWatcher.Management/client.tsp diff --git a/specification/databasewatcher/DatabaseWatcher.Management/client.tsp b/specification/databasewatcher/DatabaseWatcher.Management/client.tsp new file mode 100644 index 000000000000..fd7c57b2db72 --- /dev/null +++ b/specification/databasewatcher/DatabaseWatcher.Management/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.DatabaseWatcher, "DatabaseWatcherMgmt", "python"); From 443a57ead6db77c28a6f0d16858c7f44f1374337 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 24 Jan 2025 11:53:54 +0800 Subject: [PATCH 32/74] impact, tspconfig for SDK (#32313) --- .../impact/Impact.Management/client.tsp | 7 +++++ .../impact/Impact.Management/tspconfig.yaml | 31 ++++++++++++++++++- 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 specification/impact/Impact.Management/client.tsp diff --git a/specification/impact/Impact.Management/client.tsp b/specification/impact/Impact.Management/client.tsp new file mode 100644 index 000000000000..ab36c55c615d --- /dev/null +++ b/specification/impact/Impact.Management/client.tsp @@ -0,0 +1,7 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.Impact, "ImpactReportingMgmtClient", "java"); +@@clientName(Microsoft.Impact, "ImpactReportingMgmtClient", "python"); diff --git a/specification/impact/Impact.Management/tspconfig.yaml b/specification/impact/Impact.Management/tspconfig.yaml index f16e463b241d..c4c59268753c 100644 --- a/specification/impact/Impact.Management/tspconfig.yaml +++ b/specification/impact/Impact.Management/tspconfig.yaml @@ -1,6 +1,6 @@ parameters: service-dir: - default: "sdk/impact" + default: "sdk/impactreporting" emit: - "@azure-tools/typespec-autorest" linter: @@ -18,3 +18,32 @@ options: clear-output-folder: true model-namespace: false namespace: "{package-dir}" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-impactreporting" + package-name: "{package-dir}" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-impactreporting" + namespace: "com.azure.resourcemanager.impactreporting" + service-name: "Impact Reporting" + flavor: azure + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/impactreporting" + package-dir: "armimpactreporting" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + "@azure-tools/typespec-ts": + flavor: "azure" + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + package-dir: "arm-impactreporting" + packageDetails: + name: "@azure/arm-impactreporting" From 53e155c955ee1ea756962da2e0b9542ceb0bdc7a Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Thu, 23 Jan 2025 21:36:15 -0800 Subject: [PATCH 33/74] Repurposed azure-sdk-for-net (#32311) --- specificationRepositoryConfiguration.json | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index 9c6ad529e741..0b2c1930d549 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -17,10 +17,6 @@ "mainRepository": "Azure/azure-sdk-for-js" }, "azure-sdk-for-net": { - "integrationRepository": "azure-sdk/azure-sdk-for-net", - "mainRepository": "Azure/azure-sdk-for-net" - }, - "azure-sdk-for-net-track2": { "integrationRepository": "azure-sdk/azure-sdk-for-net", "mainRepository": "Azure/azure-sdk-for-net", "configFilePath": "eng/swagger_to_sdk_config.json" @@ -52,10 +48,6 @@ "mainRepository": "Azure/azure-sdk-for-js-pr" }, "azure-sdk-for-net": { - "integrationRepository": "azure-sdk/azure-sdk-for-net-pr", - "mainRepository": "Azure/azure-sdk-for-net-pr" - }, - "azure-sdk-for-net-track2": { "integrationRepository": "azure-sdk/azure-sdk-for-net-pr", "mainRepository": "Azure/azure-sdk-for-net-pr", "configFilePath": "eng/swagger_to_sdk_config.json" @@ -74,7 +66,7 @@ "typespecEmitterToSdkRepositoryMapping": { "@azure-tools/typespec-python": "azure-sdk-for-python", "@azure-tools/typespec-java": "azure-sdk-for-java", - "@azure-tools/typespec-csharp": "azure-sdk-for-net-track2", + "@azure-tools/typespec-csharp": "azure-sdk-for-net", "@azure-tools/typespec-ts": "azure-sdk-for-js", "@azure-tools/typespec-go": "azure-sdk-for-go" } From dbee439b1a1b0129a7e028658c0f0c7ffc305118 Mon Sep 17 00:00:00 2001 From: Arthur Ma Date: Fri, 24 Jan 2025 13:58:09 +0800 Subject: [PATCH 34/74] Update client settings to release .Net SDK for IotOperations (#32209) --- .../IoTOperations.Management/client.tsp | 85 +++++++++++++++++-- .../IoTOperations.Management/tspconfig.yaml | 6 +- 2 files changed, 83 insertions(+), 8 deletions(-) diff --git a/specification/iotoperations/IoTOperations.Management/client.tsp b/specification/iotoperations/IoTOperations.Management/client.tsp index ad321de4dbc7..2520d42b9d5d 100644 --- a/specification/iotoperations/IoTOperations.Management/client.tsp +++ b/specification/iotoperations/IoTOperations.Management/client.tsp @@ -2,13 +2,86 @@ import "./main.tsp"; import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; +using Microsoft.IoTOperations; +#suppress "@azure-tools/typespec-azure-core/casing-style" @@clientName(Microsoft.IoTOperations, "IoTOperationsMgmt", "python"); @@clientName(Microsoft.IoTOperations, "IoTOperationsManagementClient", "java"); -#suppress "@azure-tools/typespec-azure-core/casing-style" -namespace Microsoft.IoTOperations { - @@clientName(CertManagerCertOptions, "CertManagerCertConfig", "csharp"); - @@clientName(DataflowOperation, "DataflowAction", "csharp"); - @@clientName(PrincipalDefinition, "PrincipalConfig", "csharp"); -} +// CSharp Client configuration +@@clientName(BrokerAuthenticationResource, + "IotOperationsBrokerAuthentication", + "csharp" +); +@@clientName(BrokerAuthenticationProperties, + "IotOperationsBrokerAuthenticationProperties", + "csharp" +); +@@clientName(BrokerAuthorizationResource, + "IotOperationsBrokerAuthorization", + "csharp" +); +@@clientName(BrokerAuthorizationProperties, + "IotOperationsBrokerAuthorizationProperties", + "csharp" +); +@@clientName(BrokerListenerResource, "IotOperationsBrokerListener", "csharp"); +@@clientName(BrokerListenerProperties, + "IotOperationsBrokerListenerProperties", + "csharp" +); +@@clientName(BrokerResource, "IotOperationsBroker", "csharp"); +@@clientName(BrokerProperties, "IotOperationsBrokerProperties", "csharp"); +@@clientName(DataflowEndpointResource, + "IotOperationsDataflowEndpoint", + "csharp" +); +@@clientName(DataflowEndpointProperties, + "IotOperationsDataflowEndpointProperties", + "csharp" +); +@@clientName(DataflowProfileResource, "IotOperationsDataflowProfile", "csharp"); +@@clientName(DataflowProfileProperties, + "IotOperationsDataflowProfileProperties", + "csharp" +); +@@clientName(DataflowResource, "IotOperationsDataflow", "csharp"); +@@clientName(DataflowProperties, "IotOperationsDataflowProperties", "csharp"); +@@clientName(InstanceResource, "IotOperationsInstance", "csharp"); +@@clientName(InstanceProperties, "IotOperationsInstanceProperties", "csharp"); +@@clientName(AdvancedSettings, "BrokerAdvancedSettings", "csharp"); +@@clientName(AuthorizationConfig, "BrokerAuthorizationConfig", "csharp"); +@@clientName(AuthorizationRule, "BrokerAuthorizationRule", "csharp"); +@@clientName(BackendChain, "BrokerBackendChain", "csharp"); +@@clientName(BatchingConfiguration, "IotOperationsBatchingConfig", "csharp"); +@@clientName(Cardinality, "BrokerCardinality", "csharp"); +@@clientName(CertManagerCertOptions, "CertManagerCertConfig", "csharp"); +@@clientName(ClientConfig, "BrokerClientConfig", "csharp"); +@@clientName(DataflowOperation, "DataflowOperationProperties", "csharp"); +@@clientName(EndpointType, "DataflowEndpointType", "csharp"); +@@clientName(ExtendedLocation, "IotOperationsExtendedLocation", "csharp"); +@@clientName(ExtendedLocationType, + "IotOperationsExtendedLocationType", + "csharp" +); +@@clientName(FilterType, "DataflowFilterType", "csharp"); +@@clientName(Frontend, "BrokerFrontend", "csharp"); +@@clientName(ListenerPort, "BrokerListenerPort", "csharp"); +@@clientName(Metrics, "IotOperationsMetrics", "csharp"); +@@clientName(MetricProperties, "IotOperationsMetricsProperties", "csharp"); +@@clientName(OperationalMode, "IotOperationsOperationalMode", "csharp"); +@@clientName(OperationType, "DataflowOperationType", "csharp"); +@@clientName(OperatorValues, "BrokerOperatorValues", "csharp"); +@@clientName(PrincipalDefinition, "PrincipalConfig", "csharp"); +@@clientName(ProfileDiagnostics, "DataflowProfileDiagnostics", "csharp"); +@@clientName(ProvisioningState, "IotOperationsProvisioningState", "csharp"); +@@clientName(SelfCheck, "BrokerDiagnosticSelfCheck", "csharp"); +@@clientName(SelfTracing, "DiagnosticSelfTracing", "csharp"); +@@clientName(ServiceType, "BlockerListenerServiceType", "csharp"); +@@clientName(SourceSerializationFormat, + "DataflowSourceSerializationFormat", + "csharp" +); +@@clientName(TlsCertMethod, "ListenerPortTlsCertMethod", "csharp"); +@@clientName(TlsProperties, "IotOperationsTlsProperties", "csharp"); +@@clientName(Traces, "BrokerDiagnosticTraces", "csharp"); diff --git a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml index 5981988e6647..0ade2da2b59c 100644 --- a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml +++ b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml @@ -11,10 +11,12 @@ options: use-read-only-status-schema: true "@azure-tools/typespec-csharp": flavor: azure - package-dir: "Azure.ResourceManager.IoTOperations" + package-dir: "Azure.ResourceManager.IotOperations" clear-output-folder: true - model-namespace: false + use-write-core: true namespace: "{package-dir}" + # Disable generate samples until CodGen fix collection initialization issue https://github.com/Azure/azure-sdk-for-net/issues/47929 + generate-sample-project: false "@azure-tools/typespec-python": package-dir: "azure-mgmt-iotoperations" package-name: "{package-dir}" From 6b24ef84f11c4f58c2d4a846ccee1eb04f0c877e Mon Sep 17 00:00:00 2001 From: Arthur Ma Date: Fri, 24 Jan 2025 14:35:28 +0800 Subject: [PATCH 35/74] Update DeviceRegistry client settings for .Net SDK release (#31749) --- .../DeviceRegistry.Management/client.tsp | 81 ++++++++++++++++++- .../DeviceRegistry.Management/main.tsp | 3 + .../DeviceRegistry.Management/tspconfig.yaml | 7 ++ 3 files changed, 90 insertions(+), 1 deletion(-) diff --git a/specification/deviceregistry/DeviceRegistry.Management/client.tsp b/specification/deviceregistry/DeviceRegistry.Management/client.tsp index 4517400f008f..f0822437d3d0 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/client.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/client.tsp @@ -2,16 +2,95 @@ import "./main.tsp"; import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; +using Microsoft.DeviceRegistry; +// Java Client configuration @@clientNamespace(Microsoft.DeviceRegistry, "com.azure.resourcemanager.deviceregistry", "java" ); -@@clientName(Microsoft.DeviceRegistry, "DeviceRegistryMgmt", "python"); + @@clientName(Microsoft.DeviceRegistry, "DeviceRegistryManagementClient", "java" ); + +// Python Client configuration +@@clientName(Microsoft.DeviceRegistry, "DeviceRegistryMgmt", "python"); + +// CSharp Client configuration +@@scope(OperationStatus.get, "!csharp"); + +@@clientName(Asset, "DeviceRegistryAsset", "csharp"); +@@clientName(AssetProperties.enabled, "IsEnabled", "csharp"); +@@clientName(AssetStatus, "DeviceRegistryAssetStatus", "csharp"); +@@clientName(AssetStatusDataset, "DeviceRegistryAssetStatusDataset", "csharp"); +@@clientName(AssetStatusError, "DeviceRegistryAssetStatusError", "csharp"); +@@clientName(AssetStatusEvent, "DeviceRegistryAssetStatusEvent", "csharp"); +@@clientName(AssetEndpointProfile, + "DeviceRegistryAssetEndpointProfile", + "csharp" +); +@@clientName(AssetEndpointProfileProperties, + "DeviceRegistryAssetEndpointProfileProperties", + "csharp" +); +@@clientName(DataPoint, "DeviceRegistryDataPoint", "csharp"); +@@clientName(DataPointBase, "DeviceRegistryDataPointBase", "csharp"); +@@clientName(Dataset, "DeviceRegistryDataset", "csharp"); +@@clientName(DiscoveredAsset, "DeviceRegistryDiscoveredAsset", "csharp"); +@@clientName(DiscoveredAssetProperties, + "DeviceRegistryDiscoveredAssetProperties", + "csharp" +); +@@clientName(DiscoveredAssetEndpointProfile, + "DeviceRegistryDiscoveredAssetEndpointProfile", + "csharp" +); +@@clientName(Event, "DeviceRegistryEvent", "csharp"); +@@clientName(EventBase, "DeviceRegistryEventBase", "csharp"); +@@clientName(Format, "DeviceRegistrySchemaFormat", "csharp"); +@@clientName(Schema, "DeviceRegistrySchema", "csharp"); +@@clientName(SchemaProperties, "DeviceRegistrySchemaProperties", "csharp"); +@@clientName(SchemaRegistry, "DeviceRegistrySchemaRegistry", "csharp"); +@@clientName(SchemaRegistryProperties, + "DeviceRegistrySchemaRegistryProperties", + "csharp" +); +@@clientName(SchemaType, "DeviceRegistrySchemaType", "csharp"); +@@clientName(SchemaVersion, "DeviceRegistrySchemaVersion", "csharp"); +@@clientName(SchemaVersionProperties, + "DeviceRegistrySchemaVersionProperties", + "csharp" +); +@@clientName(BillingContainer, "DeviceRegistryBillingContainer", "csharp"); +@@clientName(ExtendedLocation, "DeviceRegistryExtendedLocation", "csharp"); +@@clientName(ExtendedLocation.type, "ExtendedLocationType", "csharp"); +@@clientName(TopicRetainType, "DeviceRegistryTopicRetainType", "csharp"); +@@clientName(ProvisioningState, "DeviceRegistryProvisioningState", "csharp"); +@@clientName(Authentication, "DeviceRegistryAuthentication", "csharp"); +@@clientName(Topic, "DeviceRegistryTopic", "csharp"); +@@clientName(UsernamePasswordCredentials, + "DeviceRegistryUsernamePasswordCredentials", + "csharp" +); +@@clientName(X509Credentials, "DeviceRegistryX509Credentials", "csharp"); + +@@alternateType(SchemaRegistryProperties.storageAccountContainerUrl, + url, + "csharp" +); +@@alternateType(AssetProperties.manufacturerUri, url, "csharp"); +@@alternateType(AssetProperties.documentationUri, url, "csharp"); +@@alternateType(BillingContainer.etag, Azure.Core.eTag, "csharp"); +@@alternateType(DiscoveredAssetProperties.manufacturerUri, url, "csharp"); +@@alternateType(DiscoveredAssetProperties.documentationUri, url, "csharp"); +@@alternateType(SchemaRegistryProperties.storageAccountContainerUrl, + url, + "csharp" +); + +// JavaScript Client configuration @@clientName(Microsoft.DeviceRegistry, "DeviceRegistryManagementClient", "javascript" diff --git a/specification/deviceregistry/DeviceRegistry.Management/main.tsp b/specification/deviceregistry/DeviceRegistry.Management/main.tsp index 844832210cca..2ad32ec367fa 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/main.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/main.tsp @@ -29,16 +29,19 @@ namespace Microsoft.DeviceRegistry; enum Versions { @doc("Microsoft.DeviceRegistry Resource Provider management API version 2023-11-01-preview.") @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) v2023_11_01_preview: "2023-11-01-preview", @doc("Microsoft.DeviceRegistry Resource Provider management API version 2024-09-01-preview.") @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) v2024_09_01_preview: "2024-09-01-preview", @doc("Microsoft.DeviceRegistry Resource Provider management API version 2024-11-01.") @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) v2024_11_01: "2024-11-01", } diff --git a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml index c009ec4498ea..3c16c432875a 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml +++ b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml @@ -13,6 +13,13 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/deviceregistry.json" use-read-only-status-schema: true omit-unreachable-types: true + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.DeviceRegistry" + flavor: azure + clear-output-folder: true + use-write-core: true + namespace: "{package-dir}" + api-version: "2024-09-01-preview" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-deviceregistry" flavor: "azure" From 62e3312e67873d702fb2c6e5c7717d99cf4d369b Mon Sep 17 00:00:00 2001 From: Nneka Okeke <149507727+NneOkeke@users.noreply.github.com> Date: Fri, 24 Jan 2025 01:52:23 -0500 Subject: [PATCH 36/74] Add renaming for javascript sdk (#32320) * add renaming for javascript sdk * update timestamp, correlationid * fixed format --- .../ComputeSchedule.Management/client.tsp | 48 ++++++++++++++----- 1 file changed, 36 insertions(+), 12 deletions(-) diff --git a/specification/computeschedule/ComputeSchedule.Management/client.tsp b/specification/computeschedule/ComputeSchedule.Management/client.tsp index d35b22a9778a..8724efb1969e 100644 --- a/specification/computeschedule/ComputeSchedule.Management/client.tsp +++ b/specification/computeschedule/ComputeSchedule.Management/client.tsp @@ -85,21 +85,45 @@ using Microsoft.ComputeSchedule; ); @@clientName(StartResourceOperationResponse.type, "ResourceType", "csharp"); -@@clientName(SubmitDeallocateRequest.correlationid, "correlationId", "csharp"); -@@clientName(SubmitStartRequest.correlationid, "correlationId", "csharp"); -@@clientName(SubmitHibernateRequest.correlationid, "correlationId", "csharp"); -@@clientName(ExecuteDeallocateRequest.correlationid, "correlationId", "csharp"); -@@clientName(ExecuteHibernateRequest.correlationid, "correlationId", "csharp"); -@@clientName(ExecuteStartRequest.correlationid, "correlationId", "csharp"); +@@clientName(SubmitDeallocateRequest.correlationid, + "correlationId", + "csharp,javascript" +); +@@clientName(SubmitStartRequest.correlationid, + "correlationId", + "csharp,javascript" +); +@@clientName(SubmitHibernateRequest.correlationid, + "correlationId", + "csharp,javascript" +); +@@clientName(ExecuteDeallocateRequest.correlationid, + "correlationId", + "csharp,javascript" +); +@@clientName(ExecuteHibernateRequest.correlationid, + "correlationId", + "csharp,javascript" +); +@@clientName(ExecuteStartRequest.correlationid, + "correlationId", + "csharp,javascript" +); @@clientName(GetOperationStatusRequest.correlationid, "correlationId", - "csharp" + "csharp,javascript" +); +@@clientName(CancelOperationsRequest.correlationid, + "correlationId", + "csharp,javascript" +); +@@clientName(Schedule.deadLine, "userRequestDeadline", "csharp,javascript"); +@@clientName(Schedule.timeZone, "userRequestTimezone", "csharp,javascript"); +@@clientName(ResourceOperationDetails.timeZone, + "operationTimezone", + "csharp,javascript" ); -@@clientName(CancelOperationsRequest.correlationid, "correlationId", "csharp"); -@@clientName(Schedule.deadLine, "userRequestDeadline", "csharp"); -@@clientName(Schedule.timeZone, "userRequestTimezone", "csharp"); -@@clientName(ResourceOperationDetails.timeZone, "operationTimezone", "csharp"); @@clientName(OperationErrorDetails.timeStamp, "errorDetailsTimestamp", - "csharp" + "csharp,javascript" ); From e84c20e3ed2ae58bf31b748bd9d458c3e8691142 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Fri, 24 Jan 2025 16:33:19 +0800 Subject: [PATCH 37/74] enable ts config for impact (#32323) --- specification/impact/Impact.Management/tspconfig.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/impact/Impact.Management/tspconfig.yaml b/specification/impact/Impact.Management/tspconfig.yaml index c4c59268753c..fa8865b4a577 100644 --- a/specification/impact/Impact.Management/tspconfig.yaml +++ b/specification/impact/Impact.Management/tspconfig.yaml @@ -41,9 +41,11 @@ options: inject-spans: true "@azure-tools/typespec-ts": flavor: "azure" + isModularLibrary: true hierarchyClient: false experimentalExtensibleEnums: true enableOperationGroup: true + generateSample: true package-dir: "arm-impactreporting" packageDetails: name: "@azure/arm-impactreporting" From caaa779589b660127ad84f8bb5dace29d33a7213 Mon Sep 17 00:00:00 2001 From: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com> Date: Fri, 24 Jan 2025 15:12:17 +0530 Subject: [PATCH 38/74] [Microsoft.LoadTestService] Improvements to Load Test Service DataPlane Specs for better SDK Generation (#32249) * Make the query parameters as csv parameters * Fixing the x-ms-pageable issue * Prettier fix * Using the recommended Typespec approach --- .../ListTestProfileRuns.json | 33 +++++++++++++++++-- .../LoadTestService/models.testprofile.tsp | 18 +++++----- .../LoadTestService/models.tsp | 4 +++ .../2023-04-01-preview/loadtestservice.json | 3 ++ .../2024-03-01-preview/loadtestservice.json | 3 ++ .../examples/ListTestProfileRuns.json | 33 +++++++++++++++++-- .../2024-05-01-preview/loadtestservice.json | 27 ++++++++++++--- .../2024-07-01-preview/loadtestservice.json | 27 ++++++++++++--- .../2024-12-01-preview/loadtestservice.json | 27 ++++++++++++--- .../stable/2022-11-01/loadtestservice.json | 3 ++ 10 files changed, 153 insertions(+), 25 deletions(-) diff --git a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json index 76e1cf9ef561..34c098917625 100644 --- a/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json +++ b/specification/loadtestservice/LoadTestService/examples/2024-05-01-preview/ListTestProfileRuns.json @@ -8,7 +8,7 @@ "minEndDateTime": "2024-05-01T16:00:46.072Z", "maxEndDateTime": "2024-05-01T16:50:46.072Z", "testProfileIds": "12345678-1234-1234-1234-123456789012", - "statuses": "ACCEPTED", + "statuses": "ACCEPTED,EXECUTING", "api-version": "2024-05-01-preview" }, "responses": { @@ -38,6 +38,35 @@ } } }, + "testRunDetails": {}, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + }, + { + "testProfileRunId": "87654321-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "EXECUTING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, "testRunDetails": { "testRun1": { "status": "DONE", @@ -45,7 +74,7 @@ "properties": {} }, "testRun2": { - "status": "DONE", + "status": "EXECUTING", "configurationId": "config2", "properties": {} } diff --git a/specification/loadtestservice/LoadTestService/models.testprofile.tsp b/specification/loadtestservice/LoadTestService/models.testprofile.tsp index 7c82e576f1c3..51a63cb24c46 100644 --- a/specification/loadtestservice/LoadTestService/models.testprofile.tsp +++ b/specification/loadtestservice/LoadTestService/models.testprofile.tsp @@ -259,11 +259,11 @@ model ListTestProfileQueryParams { lastModifiedEndTime?: utcDateTime; @doc("Comma separated list of IDs of the test profiles to filter.") - @query - testProfileIds?: string; + @query(#{ explode: false }) + testProfileIds?: string[]; @doc("Comma separated list IDs of the tests which should be associated with the test profiles to fetch.") - @query + @query(#{ explode: false }) testIds?: string; } @@ -311,14 +311,14 @@ model ListTestProfileRunQueryParams { createdDateEndTime?: utcDateTime; @doc("Comma separated list of IDs of the test profile runs to filter.") - @query - testProfileRunIds?: string; + @query(#{ explode: false }) + testProfileRunIds?: string[]; @doc("Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.") - @query - testProfileIds?: string; + @query(#{ explode: false }) + testProfileIds?: string[]; @doc("Comma separated list of Statuses of the test profile runs to filter.") - @query - statuses?: string; + @query(#{ explode: false }) + statuses?: string[]; } diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index 561da502ece4..21e3fcbcf421 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -2,6 +2,7 @@ import "@typespec/rest"; import "@typespec/http"; import "@azure-tools/typespec-azure-core"; +using Azure.Core; using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; @@ -1102,6 +1103,7 @@ model DimensionValue { } @doc("Metrics dimension values.") +@pagedResult model DimensionValueList { @doc("The dimension name") @visibility("read") @@ -1109,9 +1111,11 @@ model DimensionValueList { name?: string; @doc("The dimension value") + @items value?: string[]; @doc("Link for the next set of values in case of paginated results, if applicable.") + @nextLink nextLink?: ResourceLocation; } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json index cf282517156b..d32efb064318 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2023-04-01-preview/loadtestservice.json @@ -633,6 +633,9 @@ "List the dimension values for the given metric dimension name.": { "$ref": "./examples/ListMetricDimensionValues.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json index cb2e47773bbb..f8e3b88fcad6 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-03-01-preview/loadtestservice.json @@ -633,6 +633,9 @@ "List the dimension values for the given metric dimension name.": { "$ref": "./examples/ListMetricDimensionValues.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json index 76e1cf9ef561..34c098917625 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/examples/ListTestProfileRuns.json @@ -8,7 +8,7 @@ "minEndDateTime": "2024-05-01T16:00:46.072Z", "maxEndDateTime": "2024-05-01T16:50:46.072Z", "testProfileIds": "12345678-1234-1234-1234-123456789012", - "statuses": "ACCEPTED", + "statuses": "ACCEPTED,EXECUTING", "api-version": "2024-05-01-preview" }, "responses": { @@ -38,6 +38,35 @@ } } }, + "testRunDetails": {}, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + }, + { + "testProfileRunId": "87654321-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "EXECUTING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, "testRunDetails": { "testRun1": { "status": "DONE", @@ -45,7 +74,7 @@ "properties": {} }, "testRun2": { - "status": "DONE", + "status": "EXECUTING", "configurationId": "config2", "properties": {} } diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json index f2a20a260fe1..c9309478a0f6 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-05-01-preview/loadtestservice.json @@ -1147,6 +1147,9 @@ "List the dimension values for the given metric dimension name.": { "$ref": "./examples/ListMetricDimensionValues.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -5133,7 +5136,11 @@ "in": "query", "description": "Comma separated list of IDs of the test profiles to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.createdDateEndTime": { @@ -5204,7 +5211,11 @@ "in": "query", "description": "Comma separated list of Statuses of the test profile runs to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.testProfileIds": { @@ -5212,7 +5223,11 @@ "in": "query", "description": "Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.testProfileRunIds": { @@ -5220,7 +5235,11 @@ "in": "query", "description": "Comma separated list of IDs of the test profile runs to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestQueryParams.lastModifiedEndTime": { diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json index ee2bb4af824a..5f6a89768a68 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json @@ -1150,6 +1150,9 @@ "List the dimension values for the given metric dimension name.": { "$ref": "./examples/ListMetricDimensionValues.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -6220,7 +6223,11 @@ "in": "query", "description": "Comma separated list of IDs of the test profiles to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.createdDateEndTime": { @@ -6291,7 +6298,11 @@ "in": "query", "description": "Comma separated list of Statuses of the test profile runs to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.testProfileIds": { @@ -6299,7 +6310,11 @@ "in": "query", "description": "Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.testProfileRunIds": { @@ -6307,7 +6322,11 @@ "in": "query", "description": "Comma separated list of IDs of the test profile runs to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestQueryParams.lastModifiedEndTime": { diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-12-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-12-01-preview/loadtestservice.json index b2e583c76911..544e7ab0ccc0 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-12-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-12-01-preview/loadtestservice.json @@ -1369,6 +1369,9 @@ "List the dimension values for the given metric dimension name.": { "$ref": "./examples/ListMetricDimensionValues.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -6905,7 +6908,11 @@ "in": "query", "description": "Comma separated list of IDs of the test profiles to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.createdDateEndTime": { @@ -6976,7 +6983,11 @@ "in": "query", "description": "Comma separated list of Statuses of the test profile runs to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.testProfileIds": { @@ -6984,7 +6995,11 @@ "in": "query", "description": "Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestProfileRunQueryParams.testProfileRunIds": { @@ -6992,7 +7007,11 @@ "in": "query", "description": "Comma separated list of IDs of the test profile runs to filter.", "required": false, - "type": "string", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", "x-ms-parameter-location": "method" }, "ListTestQueryParams.lastModifiedEndTime": { diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json index 241373cdce9d..d974c63aae73 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json @@ -633,6 +633,9 @@ "List the dimension values for the given metric dimension name.": { "$ref": "./examples/ListMetricDimensionValues.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, From b770b86265d5dc3a26b16c5d30a736e6bbba04de Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Fri, 24 Jan 2025 08:36:46 -0800 Subject: [PATCH 39/74] Removed -track2 from the SDK name (#32312) --- dev/cognitiveservices/data-plane/Language/readme.md | 2 +- documentation/ci-fix.md | 1 - .../samplefiles-dp/samplefiles-dp-for-multi-client/README.md | 2 +- .../samplefiles-dp/samplefiles-dp-for-single-client/README.md | 2 +- specification/advisor/resource-manager/readme.md | 2 +- specification/alertsmanagement/resource-manager/readme.md | 2 +- specification/apicenter/data-plane/readme.md | 2 +- specification/apimanagement/resource-manager/readme.md | 2 +- specification/app/data-plane/readme.md | 2 +- .../appcomplianceautomation/resource-manager/readme.md | 2 +- specification/appconfiguration/resource-manager/readme.md | 2 +- specification/applicationinsights/resource-manager/readme.md | 2 +- specification/appplatform/resource-manager/readme.md | 2 +- specification/attestation/data-plane/readme.md | 2 +- specification/attestation/resource-manager/readme.md | 2 +- specification/authorization/resource-manager/readme.md | 2 +- specification/automanage/resource-manager/readme.md | 2 +- specification/automation/resource-manager/readme.md | 2 +- specification/azure-kusto/resource-manager/readme.md | 2 +- specification/azurefleet/resource-manager/readme.md | 2 +- specification/batch/resource-manager/readme.md | 2 +- specification/billing/resource-manager/readme.md | 2 +- specification/blueprint/resource-manager/readme.md | 2 +- specification/botservice/resource-manager/readme.md | 2 +- specification/cdn/resource-manager/readme.md | 2 +- specification/codesigning/resource-manager/readme.md | 2 +- .../cognitiveservices/data-plane/AnomalyDetector/readme.md | 2 +- .../cognitiveservices/data-plane/ContentSafety/readme.md | 2 +- .../cognitiveservices/data-plane/FormRecognizer/readme.md | 2 +- .../data-plane/Language/preview/2023-04-15-preview/readme.md | 2 +- .../data-plane/Language/preview/2024-05-15-preview/readme.md | 2 +- specification/cognitiveservices/data-plane/Language/readme.md | 2 +- .../cognitiveservices/data-plane/MetricsAdvisor/readme.md | 2 +- .../cognitiveservices/data-plane/TextAnalytics/readme.md | 2 +- .../cognitiveservices/data-plane/TranslatorText/readme.md | 2 +- specification/cognitiveservices/resource-manager/readme.md | 2 +- specification/communication/resource-manager/readme.md | 2 +- specification/compute/resource-manager/readme.md | 2 +- specification/confidentialledger/resource-manager/readme.md | 2 +- specification/confluent/resource-manager/readme.md | 2 +- specification/consumption/resource-manager/readme.md | 2 +- specification/containerinstance/resource-manager/readme.md | 2 +- specification/containerregistry/data-plane/readme.md | 2 +- specification/containerregistry/resource-manager/readme.md | 2 +- .../resource-manager/Microsoft.ContainerService/aks/readme.md | 2 +- .../Microsoft.ContainerService/fleet/readme.md | 2 +- specification/cosmos-db/resource-manager/readme.md | 2 +- specification/cost-management/resource-manager/readme.md | 2 +- specification/customer-insights/resource-manager/readme.md | 2 +- specification/dashboard/resource-manager/readme.md | 2 +- specification/databox/resource-manager/readme.md | 2 +- specification/databoxedge/resource-manager/readme.md | 2 +- specification/datadog/resource-manager/readme.md | 2 +- specification/datafactory/resource-manager/readme.md | 2 +- specification/datalake-analytics/resource-manager/readme.md | 2 +- specification/datalake-store/resource-manager/readme.md | 2 +- specification/datamigration/resource-manager/readme.md | 2 +- specification/dataprotection/resource-manager/readme.md | 2 +- specification/datashare/resource-manager/readme.md | 2 +- .../desktopvirtualization/resource-manager/readme.md | 2 +- .../deviceprovisioningservices/resource-manager/readme.md | 2 +- specification/deviceupdate/resource-manager/readme.md | 2 +- specification/devspaces/resource-manager/readme.md | 2 +- specification/devtestlabs/resource-manager/readme.md | 2 +- specification/digitaltwins/data-plane/readme.md | 2 +- specification/dns/resource-manager/readme.md | 2 +- specification/dnsresolver/resource-manager/readme.md | 2 +- .../edge/resource-manager/Microsoft.Edge/edge/readme.md | 2 +- .../edge/resource-manager/Microsoft.Edge/sites/readme.md | 2 +- specification/edgeorder/resource-manager/readme.md | 2 +- specification/elasticsan/resource-manager/readme.md | 2 +- specification/eventgrid/data-plane/readme.md | 2 +- specification/eventgrid/resource-manager/readme.md | 2 +- specification/eventhub/resource-manager/readme.md | 2 +- specification/extendedlocation/resource-manager/readme.md | 2 +- specification/fluidrelay/resource-manager/readme.md | 2 +- specification/frontdoor/resource-manager/readme.md | 2 +- specification/graphservicesprod/resource-manager/readme.md | 2 +- specification/guestconfiguration/resource-manager/readme.md | 2 +- .../Microsoft.HDInsight/HDInsightOnAks/readme.md | 2 +- specification/hdinsight/resource-manager/readme.md | 2 +- specification/healthcareapis/resource-manager/readme.md | 2 +- .../data-plane/HealthDataAIServices.DeidServices/readme.md | 2 +- specification/healthdataaiservices/resource-manager/readme.md | 2 +- specification/hybridcloud/resource-manager/readme.md | 2 +- specification/hybridcompute/resource-manager/readme.md | 2 +- specification/hybridconnectivity/resource-manager/readme.md | 2 +- specification/hybridkubernetes/resource-manager/readme.md | 2 +- specification/impact/resource-manager/readme.md | 2 +- specification/iotcentral/resource-manager/readme.md | 2 +- specification/iothub/resource-manager/readme.md | 4 ++-- specification/keyvault/resource-manager/readme.md | 2 +- specification/labservices/resource-manager/readme.md | 2 +- specification/loadtestservice/data-plane/readme.md | 2 +- specification/logic/resource-manager/readme.md | 2 +- .../machinelearningservices/resource-manager/readme.md | 2 +- specification/managednetwork/resource-manager/readme.md | 2 +- specification/managednetworkfabric/resource-manager/readme.md | 2 +- specification/managedservices/resource-manager/readme.md | 2 +- specification/managementpartner/resource-manager/readme.md | 2 +- specification/maps/resource-manager/readme.md | 2 +- specification/marketplace/resource-manager/readme.md | 2 +- specification/marketplaceordering/resource-manager/readme.md | 2 +- specification/mediaservices/resource-manager/readme.md | 2 +- .../Microsoft.Migrate/AssessmentProjects/readme.md | 2 +- .../Microsoft.Migrate/MigrateProjects/readme.md | 2 +- .../Microsoft.Migrate/MordernizeProjects/readme.md | 2 +- .../migrate/resource-manager/Microsoft.OffAzure/readme.md | 2 +- specification/migrate/resource-manager/readme.md | 2 +- specification/mixedreality/data-plane/readme.md | 2 +- specification/mixedreality/resource-manager/readme.md | 2 +- specification/mongocluster/resource-manager/readme.md | 2 +- .../resource-manager/Microsoft.Monitor/Operations/readme.md | 2 +- .../Microsoft.Monitor/PipelineGroups/readme.md | 2 +- specification/monitor/resource-manager/readme.md | 2 +- specification/msi/resource-manager/readme.md | 2 +- specification/mysql/resource-manager/readme.md | 2 +- specification/netapp/resource-manager/readme.md | 2 +- specification/network/resource-manager/readme.md | 2 +- specification/notificationhubs/resource-manager/readme.md | 2 +- specification/offazurespringboot/resource-manager/readme.md | 2 +- specification/operationalinsights/resource-manager/readme.md | 2 +- specification/oracle/resource-manager/readme.md | 2 +- specification/peering/resource-manager/readme.md | 2 +- specification/playwrighttesting/data-plane/readme.md | 2 +- specification/policyinsights/resource-manager/readme.md | 2 +- specification/postgresql/resource-manager/readme.md | 2 +- specification/powerbidedicated/resource-manager/readme.md | 2 +- specification/privatedns/resource-manager/readme.md | 2 +- specification/programmableconnectivity/data-plane/readme.md | 2 +- specification/providerhub/resource-manager/readme.md | 2 +- specification/purview/data-plane/readme.md | 2 +- specification/quota/resource-manager/readme.md | 2 +- specification/recoveryservices/resource-manager/readme.md | 2 +- .../recoveryservicesbackup/resource-manager/readme.md | 2 +- .../resource-manager/readme.md | 2 +- .../recoveryservicessiterecovery/resource-manager/readme.md | 2 +- specification/redis/resource-manager/readme.md | 2 +- specification/redisenterprise/resource-manager/readme.md | 2 +- specification/relay/resource-manager/readme.md | 2 +- specification/reservations/resource-manager/readme.md | 2 +- specification/resourcegraph/resource-manager/readme.md | 2 +- specification/resources/resource-manager/readme.md | 2 +- specification/search/data-plane/Azure.Search/readme.md | 2 +- specification/search/resource-manager/readme.md | 2 +- specification/security/resource-manager/readme.md | 2 +- specification/securityinsights/resource-manager/readme.md | 2 +- specification/servicebus/resource-manager/readme.md | 2 +- specification/servicefabric/resource-manager/readme.md | 2 +- .../servicefabricmanagedclusters/resource-manager/readme.md | 2 +- specification/signalr/resource-manager/readme.md | 2 +- specification/sphere/resource-manager/readme.md | 2 +- specification/sql/resource-manager/readme.md | 2 +- specification/sqlvirtualmachine/resource-manager/readme.md | 2 +- specification/storage/resource-manager/readme.md | 2 +- specification/storageactions/resource-manager/readme.md | 2 +- specification/storagecache/resource-manager/readme.md | 2 +- specification/storagepool/resource-manager/readme.md | 2 +- specification/storagesync/resource-manager/readme.md | 2 +- specification/streamanalytics/resource-manager/readme.md | 2 +- specification/subscription/resource-manager/readme.md | 2 +- specification/support/resource-manager/readme.md | 2 +- specification/synapse/resource-manager/readme.md | 2 +- specification/trafficmanager/resource-manager/readme.md | 2 +- specification/videoanalyzer/data-plane/readme.md | 2 +- specification/voiceservices/resource-manager/readme.md | 2 +- specification/web/resource-manager/readme.md | 2 +- specification/webpubsub/data-plane/readme.md | 2 +- specification/webpubsub/resource-manager/readme.md | 2 +- specification/workloadmonitor/resource-manager/readme.md | 2 +- .../Microsoft.Workloads/SAPDiscoverySites/readme.md | 2 +- .../resource-manager/Microsoft.Workloads/connectors/readme.md | 2 +- specification/workloads/resource-manager/readme.md | 2 +- 173 files changed, 173 insertions(+), 174 deletions(-) diff --git a/dev/cognitiveservices/data-plane/Language/readme.md b/dev/cognitiveservices/data-plane/Language/readme.md index 7277c0d1e537..b0aa3455b3e3 100644 --- a/dev/cognitiveservices/data-plane/Language/readme.md +++ b/dev/cognitiveservices/data-plane/Language/readme.md @@ -44,6 +44,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python ``` diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 59e8ae9043c8..23f2a2e9ee39 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -92,7 +92,6 @@ If you have an issue or with any of checks listed in the first column of the tab | `SDK azure-sdk-for-java` | Weidong Xu | [weidongxu-microsoft](https://github.com/weidongxu-microsoft) | | `SDK azure-sdk-for-js` | Qiaoqiao Zhang | [qiaozha](https://github.com/qiaozha) | | `SDK azure-sdk-for-net` | Wei Hu | [live1206](https://github.com/live1206) | -| `SDK azure-sdk-for-net-track2` | Wei Hu | [live1206](https://github.com/live1206) | | `SDK azure-sdk-for-python` | Yuchao Yan | [msyyc](https://github.com/msyyc) | Do the following: diff --git a/documentation/samplefiles-dp/samplefiles-dp-for-multi-client/README.md b/documentation/samplefiles-dp/samplefiles-dp-for-multi-client/README.md index e50925ee78a7..b777412aa8bc 100644 --- a/documentation/samplefiles-dp/samplefiles-dp-for-multi-client/README.md +++ b/documentation/samplefiles-dp/samplefiles-dp-for-multi-client/README.md @@ -81,5 +81,5 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/documentation/samplefiles-dp/samplefiles-dp-for-single-client/README.md b/documentation/samplefiles-dp/samplefiles-dp-for-single-client/README.md index 0339d2b73fad..d0033dc14b95 100644 --- a/documentation/samplefiles-dp/samplefiles-dp-for-single-client/README.md +++ b/documentation/samplefiles-dp/samplefiles-dp-for-single-client/README.md @@ -53,5 +53,5 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/advisor/resource-manager/readme.md b/specification/advisor/resource-manager/readme.md index 003df622c59e..bda9e84bc0ca 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -121,7 +121,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md index 6cf150503fb0..771c49b69b3b 100644 --- a/specification/alertsmanagement/resource-manager/readme.md +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -224,7 +224,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/apicenter/data-plane/readme.md b/specification/apicenter/data-plane/readme.md index a50d49dc079e..078c8fa36f12 100644 --- a/specification/apicenter/data-plane/readme.md +++ b/specification/apicenter/data-plane/readme.md @@ -52,7 +52,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ### Suppressions diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 8c9a27b697c1..214cc873eeed 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -1110,7 +1110,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/app/data-plane/readme.md b/specification/app/data-plane/readme.md index 6fc752bc4276..1845fa6e9c36 100644 --- a/specification/app/data-plane/readme.md +++ b/specification/app/data-plane/readme.md @@ -47,5 +47,5 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` \ No newline at end of file diff --git a/specification/appcomplianceautomation/resource-manager/readme.md b/specification/appcomplianceautomation/resource-manager/readme.md index c157270c0b4a..db658ac28f57 100644 --- a/specification/appcomplianceautomation/resource-manager/readme.md +++ b/specification/appcomplianceautomation/resource-manager/readme.md @@ -63,7 +63,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas - repo: azure-cli-extensions ``` diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md index ae4ab064f90e..8b8f5a2ee77c 100644 --- a/specification/appconfiguration/resource-manager/readme.md +++ b/specification/appconfiguration/resource-manager/readme.md @@ -158,7 +158,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-sdk-for-go diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index 9aa8b3dd161e..f4b04de33ab8 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -810,7 +810,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/appplatform/resource-manager/readme.md b/specification/appplatform/resource-manager/readme.md index 6899c14530e5..75ee0fa2bb79 100644 --- a/specification/appplatform/resource-manager/readme.md +++ b/specification/appplatform/resource-manager/readme.md @@ -253,7 +253,7 @@ swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-node - repo: azure-sdk-for-js - repo: azure-sdk-for-go diff --git a/specification/attestation/data-plane/readme.md b/specification/attestation/data-plane/readme.md index dac99e88d367..387fc99546bb 100644 --- a/specification/attestation/data-plane/readme.md +++ b/specification/attestation/data-plane/readme.md @@ -74,7 +74,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## Python diff --git a/specification/attestation/resource-manager/readme.md b/specification/attestation/resource-manager/readme.md index a9fab34a546e..0b60f18d6a75 100644 --- a/specification/attestation/resource-manager/readme.md +++ b/specification/attestation/resource-manager/readme.md @@ -75,7 +75,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index 58d6c1637ddf..c794fb05485c 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -639,7 +639,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/automanage/resource-manager/readme.md b/specification/automanage/resource-manager/readme.md index 5b0a4e4d87ed..06d7b15d93b1 100644 --- a/specification/automanage/resource-manager/readme.md +++ b/specification/automanage/resource-manager/readme.md @@ -89,7 +89,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/automation/resource-manager/readme.md b/specification/automation/resource-manager/readme.md index 5a1d2dd8d478..a1e95cb73aa6 100644 --- a/specification/automation/resource-manager/readme.md +++ b/specification/automation/resource-manager/readme.md @@ -684,7 +684,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index 724f4ead3ca4..e18e718f92b5 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -255,7 +255,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-go diff --git a/specification/azurefleet/resource-manager/readme.md b/specification/azurefleet/resource-manager/readme.md index 660c328dcf26..5efb46981174 100644 --- a/specification/azurefleet/resource-manager/readme.md +++ b/specification/azurefleet/resource-manager/readme.md @@ -87,7 +87,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 920ee7f4cfb2..68f97287d8b1 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -285,7 +285,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index cd6b57a5b528..5b6c81c151c3 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -381,7 +381,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/blueprint/resource-manager/readme.md b/specification/blueprint/resource-manager/readme.md index 77785fa61b81..c06136cdd4d0 100644 --- a/specification/blueprint/resource-manager/readme.md +++ b/specification/blueprint/resource-manager/readme.md @@ -59,7 +59,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-python diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md index 9e6f5a163d07..e1eaaf68751c 100644 --- a/specification/botservice/resource-manager/readme.md +++ b/specification/botservice/resource-manager/readme.md @@ -201,7 +201,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-python - repo: azure-sdk-for-go diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index 443c5a4a8a57..0cfb4cb500e4 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -259,7 +259,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby diff --git a/specification/codesigning/resource-manager/readme.md b/specification/codesigning/resource-manager/readme.md index cf10e999a1d8..241a30159435 100644 --- a/specification/codesigning/resource-manager/readme.md +++ b/specification/codesigning/resource-manager/readme.md @@ -61,7 +61,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-cli-extensions - repo: azure-sdk-for-go - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-sdk-for-typescript diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md b/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md index f7b8cf91dd6d..067b2fc9b514 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/readme.md @@ -64,7 +64,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## CSharp Settings diff --git a/specification/cognitiveservices/data-plane/ContentSafety/readme.md b/specification/cognitiveservices/data-plane/ContentSafety/readme.md index eb53478c210e..fc4ca1253dee 100644 --- a/specification/cognitiveservices/data-plane/ContentSafety/readme.md +++ b/specification/cognitiveservices/data-plane/ContentSafety/readme.md @@ -84,7 +84,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md index 6b0ff6ba2063..86a418365bd4 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md +++ b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md @@ -144,7 +144,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md index 79bcdf7f7e2a..3c61b1a3a17d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/readme.md @@ -71,7 +71,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python ``` diff --git a/specification/cognitiveservices/data-plane/Language/preview/2024-05-15-preview/readme.md b/specification/cognitiveservices/data-plane/Language/preview/2024-05-15-preview/readme.md index 091738ac4ebe..57c28c0e79c1 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2024-05-15-preview/readme.md +++ b/specification/cognitiveservices/data-plane/Language/preview/2024-05-15-preview/readme.md @@ -38,7 +38,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python ``` diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 76d38eadb840..a6d5377bb67a 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -297,5 +297,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md b/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md index 3d588fcab50e..a15307ce8a8b 100644 --- a/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md +++ b/specification/cognitiveservices/data-plane/MetricsAdvisor/readme.md @@ -30,5 +30,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index b8c3cca16ad9..50d5d89e2e45 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -147,7 +147,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## CSharp Settings diff --git a/specification/cognitiveservices/data-plane/TranslatorText/readme.md b/specification/cognitiveservices/data-plane/TranslatorText/readme.md index 752deadf23a8..f07abe8239e9 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/readme.md +++ b/specification/cognitiveservices/data-plane/TranslatorText/readme.md @@ -55,7 +55,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## CSharp Settings diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index 5f02975eed28..f0abbe76e0a2 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -164,7 +164,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/communication/resource-manager/readme.md b/specification/communication/resource-manager/readme.md index d32f76c6aab9..139852211b8f 100644 --- a/specification/communication/resource-manager/readme.md +++ b/specification/communication/resource-manager/readme.md @@ -140,7 +140,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 2624853140e9..5cd125cb6f5b 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -2240,7 +2240,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-js diff --git a/specification/confidentialledger/resource-manager/readme.md b/specification/confidentialledger/resource-manager/readme.md index 879c89eda746..a0b779fc35c9 100644 --- a/specification/confidentialledger/resource-manager/readme.md +++ b/specification/confidentialledger/resource-manager/readme.md @@ -118,7 +118,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/confluent/resource-manager/readme.md b/specification/confluent/resource-manager/readme.md index 02fa61987064..d5dff2bc598a 100644 --- a/specification/confluent/resource-manager/readme.md +++ b/specification/confluent/resource-manager/readme.md @@ -112,7 +112,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/consumption/resource-manager/readme.md b/specification/consumption/resource-manager/readme.md index 18ed4b5658ab..095035a9d830 100644 --- a/specification/consumption/resource-manager/readme.md +++ b/specification/consumption/resource-manager/readme.md @@ -291,7 +291,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-java diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index f1704bde3d87..072a2d3096fb 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -260,7 +260,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/containerregistry/data-plane/readme.md b/specification/containerregistry/data-plane/readme.md index 68b8579e1b2c..41dfdc73ee1c 100644 --- a/specification/containerregistry/data-plane/readme.md +++ b/specification/containerregistry/data-plane/readme.md @@ -73,7 +73,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md index b795993a551f..dcc655c529d2 100644 --- a/specification/containerregistry/resource-manager/readme.md +++ b/specification/containerregistry/resource-manager/readme.md @@ -421,7 +421,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 9bf7fc18a252..0a653e9f99a9 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -1189,7 +1189,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.md index e98dbb2e87d7..ebb4f8f48249 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/readme.md @@ -136,7 +136,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-node - repo: azure-resource-manager-schemas - repo: azure-powershell diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index a62b39efce2e..3f5fc2e8d473 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -1003,7 +1003,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index bb07592be49f..37903a1a11b2 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -559,7 +559,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-node diff --git a/specification/customer-insights/resource-manager/readme.md b/specification/customer-insights/resource-manager/readme.md index 3f804da88718..800347a98399 100644 --- a/specification/customer-insights/resource-manager/readme.md +++ b/specification/customer-insights/resource-manager/readme.md @@ -61,7 +61,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node diff --git a/specification/dashboard/resource-manager/readme.md b/specification/dashboard/resource-manager/readme.md index e43a7b37dbcc..29e775a11fe3 100644 --- a/specification/dashboard/resource-manager/readme.md +++ b/specification/dashboard/resource-manager/readme.md @@ -103,7 +103,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-resource-manager-schemas diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index 0aee3365845a..13026eee4ce3 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -185,7 +185,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-node diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index b02fbd471f80..6682dea6ff6b 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -200,7 +200,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-go diff --git a/specification/datadog/resource-manager/readme.md b/specification/datadog/resource-manager/readme.md index e8d70147b664..e987a543bebc 100644 --- a/specification/datadog/resource-manager/readme.md +++ b/specification/datadog/resource-manager/readme.md @@ -99,7 +99,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index 16c12afb0ab3..3cca843a813b 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -86,7 +86,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/datalake-analytics/resource-manager/readme.md b/specification/datalake-analytics/resource-manager/readme.md index 1cb2c27391f8..67e488ed56a5 100644 --- a/specification/datalake-analytics/resource-manager/readme.md +++ b/specification/datalake-analytics/resource-manager/readme.md @@ -82,7 +82,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/datalake-store/resource-manager/readme.md b/specification/datalake-store/resource-manager/readme.md index 52f3456115e3..15d7e75bec20 100644 --- a/specification/datalake-store/resource-manager/readme.md +++ b/specification/datalake-store/resource-manager/readme.md @@ -75,7 +75,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index 79c9472342d4..27fd687b5db3 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -514,7 +514,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/dataprotection/resource-manager/readme.md b/specification/dataprotection/resource-manager/readme.md index 3ac946284bf5..bca8d58cccb0 100644 --- a/specification/dataprotection/resource-manager/readme.md +++ b/specification/dataprotection/resource-manager/readme.md @@ -301,7 +301,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/datashare/resource-manager/readme.md b/specification/datashare/resource-manager/readme.md index b9587e356bac..f05fc81b5259 100644 --- a/specification/datashare/resource-manager/readme.md +++ b/specification/datashare/resource-manager/readme.md @@ -86,7 +86,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-cli-extensions diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index 7e58079bb52f..a0b5bb237b23 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -304,7 +304,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 23b469e6f14a..abe95a812923 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -141,7 +141,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/deviceupdate/resource-manager/readme.md b/specification/deviceupdate/resource-manager/readme.md index 09538f0780cf..33debce6b6a1 100644 --- a/specification/deviceupdate/resource-manager/readme.md +++ b/specification/deviceupdate/resource-manager/readme.md @@ -100,7 +100,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go after_scripts: diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md index cbf1795b1190..6d887adaa821 100644 --- a/specification/devspaces/resource-manager/readme.md +++ b/specification/devspaces/resource-manager/readme.md @@ -50,7 +50,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/devtestlabs/resource-manager/readme.md b/specification/devtestlabs/resource-manager/readme.md index 0130f484d8d2..074a2ebbb7d9 100644 --- a/specification/devtestlabs/resource-manager/readme.md +++ b/specification/devtestlabs/resource-manager/readme.md @@ -69,7 +69,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-python - repo: azure-sdk-for-java diff --git a/specification/digitaltwins/data-plane/readme.md b/specification/digitaltwins/data-plane/readme.md index 16f7ce1a2670..c187742404fa 100644 --- a/specification/digitaltwins/data-plane/readme.md +++ b/specification/digitaltwins/data-plane/readme.md @@ -103,7 +103,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## Go diff --git a/specification/dns/resource-manager/readme.md b/specification/dns/resource-manager/readme.md index 0376b860d0a5..8a1282c042c3 100644 --- a/specification/dns/resource-manager/readme.md +++ b/specification/dns/resource-manager/readme.md @@ -227,7 +227,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node diff --git a/specification/dnsresolver/resource-manager/readme.md b/specification/dnsresolver/resource-manager/readme.md index 1631ce0a8260..22a6b8aa0c39 100644 --- a/specification/dnsresolver/resource-manager/readme.md +++ b/specification/dnsresolver/resource-manager/readme.md @@ -68,7 +68,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-powershell diff --git a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md index 08c02295fabb..1ffcb799fbab 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md +++ b/specification/edge/resource-manager/Microsoft.Edge/edge/readme.md @@ -55,7 +55,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## Az diff --git a/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md b/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md index 2513106ee323..e790ec15e829 100644 --- a/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md +++ b/specification/edge/resource-manager/Microsoft.Edge/sites/readme.md @@ -64,7 +64,7 @@ swagger-to-sdk: - repo: azure-resource-manager-schemas - repo: azure-cli-extensions - repo: azure-powershell - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## Az diff --git a/specification/edgeorder/resource-manager/readme.md b/specification/edgeorder/resource-manager/readme.md index aa458e4174d7..ba6edfdad611 100644 --- a/specification/edgeorder/resource-manager/readme.md +++ b/specification/edgeorder/resource-manager/readme.md @@ -82,7 +82,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-powershell diff --git a/specification/elasticsan/resource-manager/readme.md b/specification/elasticsan/resource-manager/readme.md index 9d32d96e4c4f..9408e777d8e1 100644 --- a/specification/elasticsan/resource-manager/readme.md +++ b/specification/elasticsan/resource-manager/readme.md @@ -84,7 +84,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index fa4c5243e6d0..ef3922aa093a 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -217,7 +217,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## C# diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index 77dd79c68ee2..fb2586ecc0df 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -333,7 +333,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index 768afd858987..dadfa454a96e 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -482,7 +482,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/extendedlocation/resource-manager/readme.md b/specification/extendedlocation/resource-manager/readme.md index f2fa08738237..4d5db17b2eb6 100644 --- a/specification/extendedlocation/resource-manager/readme.md +++ b/specification/extendedlocation/resource-manager/readme.md @@ -68,7 +68,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/fluidrelay/resource-manager/readme.md b/specification/fluidrelay/resource-manager/readme.md index d56a3822c03c..05f7f1bb0d8a 100644 --- a/specification/fluidrelay/resource-manager/readme.md +++ b/specification/fluidrelay/resource-manager/readme.md @@ -123,7 +123,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index c412f49f52be..61f9fed8119a 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -244,7 +244,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/graphservicesprod/resource-manager/readme.md b/specification/graphservicesprod/resource-manager/readme.md index f44e9e0be14d..8439c63d47d1 100644 --- a/specification/graphservicesprod/resource-manager/readme.md +++ b/specification/graphservicesprod/resource-manager/readme.md @@ -60,7 +60,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-js diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 1b7cf6b255dc..59ba937f5b48 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -144,7 +144,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md index f78f6a870e58..cb16a494a112 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md @@ -143,7 +143,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-java - repo: azure-sdk-for-python diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index 3f6348465500..68671ad4c2de 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -269,7 +269,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-java - repo: azure-sdk-for-python diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index 1f564f097a6f..d2f96a97afa1 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -203,7 +203,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md index 883a2262edbb..bc1e06a2e1f6 100644 --- a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/readme.md @@ -53,7 +53,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-js diff --git a/specification/healthdataaiservices/resource-manager/readme.md b/specification/healthdataaiservices/resource-manager/readme.md index 1e57a362f63d..c1e79c8beb60 100644 --- a/specification/healthdataaiservices/resource-manager/readme.md +++ b/specification/healthdataaiservices/resource-manager/readme.md @@ -60,7 +60,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/hybridcloud/resource-manager/readme.md b/specification/hybridcloud/resource-manager/readme.md index f80a1b324b52..4a5eb2b7e46d 100644 --- a/specification/hybridcloud/resource-manager/readme.md +++ b/specification/hybridcloud/resource-manager/readme.md @@ -63,7 +63,7 @@ swagger-to-sdk: - repo: azure-resource-manager-schemas - repo: azure-cli-extensions - repo: azure-powershell - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## Az diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index dfa4f4b0fff4..acfccacf3c8a 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -363,7 +363,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/hybridconnectivity/resource-manager/readme.md b/specification/hybridconnectivity/resource-manager/readme.md index 9ce640172741..ebcc5c9b571f 100644 --- a/specification/hybridconnectivity/resource-manager/readme.md +++ b/specification/hybridconnectivity/resource-manager/readme.md @@ -100,7 +100,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/hybridkubernetes/resource-manager/readme.md b/specification/hybridkubernetes/resource-manager/readme.md index d9adf6992e76..ec310b8dfb94 100644 --- a/specification/hybridkubernetes/resource-manager/readme.md +++ b/specification/hybridkubernetes/resource-manager/readme.md @@ -160,7 +160,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-ruby - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_hybridkubernetes'] - repo: azure-resource-manager-schemas diff --git a/specification/impact/resource-manager/readme.md b/specification/impact/resource-manager/readme.md index 25a70c8b5bb0..46a47d81cbaf 100644 --- a/specification/impact/resource-manager/readme.md +++ b/specification/impact/resource-manager/readme.md @@ -66,7 +66,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas - repo: azure-cli-extensions - repo: azure-powershell diff --git a/specification/iotcentral/resource-manager/readme.md b/specification/iotcentral/resource-manager/readme.md index 33301a93933d..c78fd5a1b1d2 100644 --- a/specification/iotcentral/resource-manager/readme.md +++ b/specification/iotcentral/resource-manager/readme.md @@ -93,7 +93,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index 95e78eeebcf5..15b839c64b71 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -302,9 +302,9 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index 74a0fe38dde3..1f0525eb2a23 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -339,7 +339,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/labservices/resource-manager/readme.md b/specification/labservices/resource-manager/readme.md index 529dbbaa8ad1..a802c7645659 100644 --- a/specification/labservices/resource-manager/readme.md +++ b/specification/labservices/resource-manager/readme.md @@ -119,7 +119,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/loadtestservice/data-plane/readme.md b/specification/loadtestservice/data-plane/readme.md index a62c42f7583b..53492d5993ef 100644 --- a/specification/loadtestservice/data-plane/readme.md +++ b/specification/loadtestservice/data-plane/readme.md @@ -103,5 +103,5 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/logic/resource-manager/readme.md b/specification/logic/resource-manager/readme.md index eceb62852f54..3288101bc7db 100644 --- a/specification/logic/resource-manager/readme.md +++ b/specification/logic/resource-manager/readme.md @@ -125,7 +125,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-trenton diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index f6719052f0b8..56ed938897ff 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -829,7 +829,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-java diff --git a/specification/managednetwork/resource-manager/readme.md b/specification/managednetwork/resource-manager/readme.md index ce6ec4b20f74..db97596c13f1 100644 --- a/specification/managednetwork/resource-manager/readme.md +++ b/specification/managednetwork/resource-manager/readme.md @@ -50,7 +50,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby diff --git a/specification/managednetworkfabric/resource-manager/readme.md b/specification/managednetworkfabric/resource-manager/readme.md index 1c52af5bd9b5..943077a83f16 100644 --- a/specification/managednetworkfabric/resource-manager/readme.md +++ b/specification/managednetworkfabric/resource-manager/readme.md @@ -97,7 +97,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-java - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-cli-extensions after_scripts: diff --git a/specification/managedservices/resource-manager/readme.md b/specification/managedservices/resource-manager/readme.md index 0d4081305f70..04a6efae363b 100644 --- a/specification/managedservices/resource-manager/readme.md +++ b/specification/managedservices/resource-manager/readme.md @@ -103,7 +103,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-python - repo: azure-sdk-for-java diff --git a/specification/managementpartner/resource-manager/readme.md b/specification/managementpartner/resource-manager/readme.md index 41b1f15b1821..f7a75e005dc0 100644 --- a/specification/managementpartner/resource-manager/readme.md +++ b/specification/managementpartner/resource-manager/readme.md @@ -71,7 +71,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/maps/resource-manager/readme.md b/specification/maps/resource-manager/readme.md index 698f8e0e6b06..8224b265fefb 100644 --- a/specification/maps/resource-manager/readme.md +++ b/specification/maps/resource-manager/readme.md @@ -141,7 +141,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/marketplace/resource-manager/readme.md b/specification/marketplace/resource-manager/readme.md index 91a20fc76304..79218ab109b0 100644 --- a/specification/marketplace/resource-manager/readme.md +++ b/specification/marketplace/resource-manager/readme.md @@ -136,7 +136,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-resource-manager-schemas - repo: azure-powershell diff --git a/specification/marketplaceordering/resource-manager/readme.md b/specification/marketplaceordering/resource-manager/readme.md index 9e2c3e25b88f..e9475b227c14 100644 --- a/specification/marketplaceordering/resource-manager/readme.md +++ b/specification/marketplaceordering/resource-manager/readme.md @@ -86,7 +86,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index 9477bd572f25..9a7ab7b96482 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -387,7 +387,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md index 16d24c1f5645..6cc346e85d39 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md @@ -129,7 +129,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md index be471c5b8b5d..58721212f1fb 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MigrateProjects/readme.md @@ -56,7 +56,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md index 1394588f35e9..c7a24fcc850f 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md +++ b/specification/migrate/resource-manager/Microsoft.Migrate/MordernizeProjects/readme.md @@ -47,7 +47,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md index 1f3db0d4ab34..1c5d815957a8 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/readme.md @@ -74,7 +74,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index 9ba1c10caed2..cfa30d4bc962 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -399,7 +399,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/mixedreality/data-plane/readme.md b/specification/mixedreality/data-plane/readme.md index d1d27b76594f..b0a63bfc7bc5 100644 --- a/specification/mixedreality/data-plane/readme.md +++ b/specification/mixedreality/data-plane/readme.md @@ -120,5 +120,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/mixedreality/resource-manager/readme.md b/specification/mixedreality/resource-manager/readme.md index e00f71b21e57..1e852fcca272 100644 --- a/specification/mixedreality/resource-manager/readme.md +++ b/specification/mixedreality/resource-manager/readme.md @@ -161,7 +161,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-go diff --git a/specification/mongocluster/resource-manager/readme.md b/specification/mongocluster/resource-manager/readme.md index ce0e5fec4322..1bf407b8fd57 100644 --- a/specification/mongocluster/resource-manager/readme.md +++ b/specification/mongocluster/resource-manager/readme.md @@ -78,7 +78,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/monitor/resource-manager/Microsoft.Monitor/Operations/readme.md b/specification/monitor/resource-manager/Microsoft.Monitor/Operations/readme.md index 595203aafb57..a27d2069bfd3 100644 --- a/specification/monitor/resource-manager/Microsoft.Monitor/Operations/readme.md +++ b/specification/monitor/resource-manager/Microsoft.Monitor/Operations/readme.md @@ -56,7 +56,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/monitor/resource-manager/Microsoft.Monitor/PipelineGroups/readme.md b/specification/monitor/resource-manager/Microsoft.Monitor/PipelineGroups/readme.md index 5346546aaacf..a0a392c87979 100644 --- a/specification/monitor/resource-manager/Microsoft.Monitor/PipelineGroups/readme.md +++ b/specification/monitor/resource-manager/Microsoft.Monitor/PipelineGroups/readme.md @@ -55,7 +55,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 61450e861bea..f05260a952a0 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -1393,7 +1393,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index 890801f89be4..dd133e95e2af 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -106,7 +106,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 11dc73270c52..8542ee94f038 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -571,7 +571,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index 0c8ff3c3068f..49a5b9979b25 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -411,7 +411,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-js - repo: azure-sdk-for-go - repo: azure-sdk-for-java diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 9ef48edc7396..d81d96a87c26 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -3787,7 +3787,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/notificationhubs/resource-manager/readme.md b/specification/notificationhubs/resource-manager/readme.md index ced0c1934cd4..e2e9189031c1 100644 --- a/specification/notificationhubs/resource-manager/readme.md +++ b/specification/notificationhubs/resource-manager/readme.md @@ -120,7 +120,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/offazurespringboot/resource-manager/readme.md b/specification/offazurespringboot/resource-manager/readme.md index df9e4eafd9e0..7238386e098a 100644 --- a/specification/offazurespringboot/resource-manager/readme.md +++ b/specification/offazurespringboot/resource-manager/readme.md @@ -63,7 +63,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/operationalinsights/resource-manager/readme.md b/specification/operationalinsights/resource-manager/readme.md index 1e339b77c81f..e5ae1603c6ad 100644 --- a/specification/operationalinsights/resource-manager/readme.md +++ b/specification/operationalinsights/resource-manager/readme.md @@ -325,7 +325,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/oracle/resource-manager/readme.md b/specification/oracle/resource-manager/readme.md index cf8d22b28d94..d78ff575cfc9 100644 --- a/specification/oracle/resource-manager/readme.md +++ b/specification/oracle/resource-manager/readme.md @@ -99,7 +99,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/peering/resource-manager/readme.md b/specification/peering/resource-manager/readme.md index 73722af95672..79d4a53613c3 100644 --- a/specification/peering/resource-manager/readme.md +++ b/specification/peering/resource-manager/readme.md @@ -133,7 +133,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby diff --git a/specification/playwrighttesting/data-plane/readme.md b/specification/playwrighttesting/data-plane/readme.md index f45a484c1af7..93a78b9d1631 100644 --- a/specification/playwrighttesting/data-plane/readme.md +++ b/specification/playwrighttesting/data-plane/readme.md @@ -81,5 +81,5 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/readme.md b/specification/policyinsights/resource-manager/readme.md index 4c3f11f1fb78..b5c56ed9b558 100644 --- a/specification/policyinsights/resource-manager/readme.md +++ b/specification/policyinsights/resource-manager/readme.md @@ -331,7 +331,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-js diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 912918b92fb6..71ae5d2de8f2 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -566,7 +566,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/powerbidedicated/resource-manager/readme.md b/specification/powerbidedicated/resource-manager/readme.md index f1ad057c3207..69922a7d3261 100644 --- a/specification/powerbidedicated/resource-manager/readme.md +++ b/specification/powerbidedicated/resource-manager/readme.md @@ -60,7 +60,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node diff --git a/specification/privatedns/resource-manager/readme.md b/specification/privatedns/resource-manager/readme.md index 5f8f806dd840..f50428d7bd4f 100644 --- a/specification/privatedns/resource-manager/readme.md +++ b/specification/privatedns/resource-manager/readme.md @@ -74,7 +74,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/programmableconnectivity/data-plane/readme.md b/specification/programmableconnectivity/data-plane/readme.md index 9afcd7bc956b..8034c93cc68d 100644 --- a/specification/programmableconnectivity/data-plane/readme.md +++ b/specification/programmableconnectivity/data-plane/readme.md @@ -53,5 +53,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` \ No newline at end of file diff --git a/specification/providerhub/resource-manager/readme.md b/specification/providerhub/resource-manager/readme.md index bf720a48aee3..4979a170cf53 100644 --- a/specification/providerhub/resource-manager/readme.md +++ b/specification/providerhub/resource-manager/readme.md @@ -100,7 +100,7 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_providerhub'] - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-powershell ``` diff --git a/specification/purview/data-plane/readme.md b/specification/purview/data-plane/readme.md index 2fe7fee5327b..2f7a0bce9495 100644 --- a/specification/purview/data-plane/readme.md +++ b/specification/purview/data-plane/readme.md @@ -396,5 +396,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/quota/resource-manager/readme.md b/specification/quota/resource-manager/readme.md index b9498f32da48..c39781c2ecf0 100644 --- a/specification/quota/resource-manager/readme.md +++ b/specification/quota/resource-manager/readme.md @@ -137,7 +137,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/recoveryservices/resource-manager/readme.md b/specification/recoveryservices/resource-manager/readme.md index ef1a5c027cf0..5a953e5a38ab 100644 --- a/specification/recoveryservices/resource-manager/readme.md +++ b/specification/recoveryservices/resource-manager/readme.md @@ -449,7 +449,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/recoveryservicesbackup/resource-manager/readme.md b/specification/recoveryservicesbackup/resource-manager/readme.md index 2e323c270173..5523cfc9201c 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.md @@ -463,7 +463,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/recoveryservicesdatareplication/resource-manager/readme.md b/specification/recoveryservicesdatareplication/resource-manager/readme.md index 21f544ec75db..efe58f62e3d9 100644 --- a/specification/recoveryservicesdatareplication/resource-manager/readme.md +++ b/specification/recoveryservicesdatareplication/resource-manager/readme.md @@ -55,7 +55,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## Az diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index f28a842c8548..89027fef7a06 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -343,7 +343,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index 3eec6808530e..03b490b6d687 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -193,7 +193,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/redisenterprise/resource-manager/readme.md b/specification/redisenterprise/resource-manager/readme.md index 8c6bb9d29957..bf9071d1e129 100644 --- a/specification/redisenterprise/resource-manager/readme.md +++ b/specification/redisenterprise/resource-manager/readme.md @@ -193,7 +193,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/relay/resource-manager/readme.md b/specification/relay/resource-manager/readme.md index 2e821bf77d66..c86240606176 100644 --- a/specification/relay/resource-manager/readme.md +++ b/specification/relay/resource-manager/readme.md @@ -99,7 +99,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/reservations/resource-manager/readme.md b/specification/reservations/resource-manager/readme.md index be89d7c882dc..8641214595f6 100644 --- a/specification/reservations/resource-manager/readme.md +++ b/specification/reservations/resource-manager/readme.md @@ -138,7 +138,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/resourcegraph/resource-manager/readme.md b/specification/resourcegraph/resource-manager/readme.md index 0526cbb2a586..eb54a64fd3b5 100644 --- a/specification/resourcegraph/resource-manager/readme.md +++ b/specification/resourcegraph/resource-manager/readme.md @@ -158,7 +158,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index c763e7989803..7cb5ab487355 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -1628,7 +1628,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index b1cc42b884bd..5cb404de221d 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -1033,5 +1033,5 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` diff --git a/specification/search/resource-manager/readme.md b/specification/search/resource-manager/readme.md index 7d171f999040..2ea97e373e10 100644 --- a/specification/search/resource-manager/readme.md +++ b/specification/search/resource-manager/readme.md @@ -148,7 +148,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 13a05a9a5c5d..e70f9dc33cdc 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -1081,7 +1081,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md index cafa2e1e94b3..967a3583a787 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -1132,7 +1132,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 3746af3ea25c..99dafcb6a143 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -236,7 +236,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/servicefabric/resource-manager/readme.md b/specification/servicefabric/resource-manager/readme.md index 5799bd9efa3d..eb65d983144c 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -197,7 +197,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/servicefabricmanagedclusters/resource-manager/readme.md b/specification/servicefabricmanagedclusters/resource-manager/readme.md index 2f22ad7f19e8..2420e073e826 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/readme.md +++ b/specification/servicefabricmanagedclusters/resource-manager/readme.md @@ -314,7 +314,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-resource-manager-schemas - repo: azure-powershell diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 07e0f6f45442..53925c960c8f 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -253,7 +253,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-node diff --git a/specification/sphere/resource-manager/readme.md b/specification/sphere/resource-manager/readme.md index 1a7c9235c56a..d5037b1f8122 100644 --- a/specification/sphere/resource-manager/readme.md +++ b/specification/sphere/resource-manager/readme.md @@ -63,7 +63,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index d08aec052d0d..fe65c2f7bc18 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -3094,7 +3094,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node diff --git a/specification/sqlvirtualmachine/resource-manager/readme.md b/specification/sqlvirtualmachine/resource-manager/readme.md index b76601e78b74..73392b66507c 100644 --- a/specification/sqlvirtualmachine/resource-manager/readme.md +++ b/specification/sqlvirtualmachine/resource-manager/readme.md @@ -114,7 +114,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-java diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index f5097fb029c5..f61a76d759be 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -840,7 +840,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/storageactions/resource-manager/readme.md b/specification/storageactions/resource-manager/readme.md index 827c179ef54e..480e1f7cec58 100644 --- a/specification/storageactions/resource-manager/readme.md +++ b/specification/storageactions/resource-manager/readme.md @@ -54,7 +54,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/storagecache/resource-manager/readme.md b/specification/storagecache/resource-manager/readme.md index a22e1d7c4dbc..486b7107fc2a 100644 --- a/specification/storagecache/resource-manager/readme.md +++ b/specification/storagecache/resource-manager/readme.md @@ -169,7 +169,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/storagepool/resource-manager/readme.md b/specification/storagepool/resource-manager/readme.md index 01e6017abf6c..09d5cf47fdcc 100644 --- a/specification/storagepool/resource-manager/readme.md +++ b/specification/storagepool/resource-manager/readme.md @@ -68,7 +68,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md index 7bf7266d7ecd..ed0078966164 100644 --- a/specification/storagesync/resource-manager/readme.md +++ b/specification/storagesync/resource-manager/readme.md @@ -148,7 +148,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index c98d8e88d106..32a5c7be1de6 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -138,7 +138,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-go - repo: azure-sdk-for-node diff --git a/specification/subscription/resource-manager/readme.md b/specification/subscription/resource-manager/readme.md index 3a3c3ffa9d73..81c1cd0ddfd9 100644 --- a/specification/subscription/resource-manager/readme.md +++ b/specification/subscription/resource-manager/readme.md @@ -171,7 +171,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-node diff --git a/specification/support/resource-manager/readme.md b/specification/support/resource-manager/readme.md index f9502bd273df..71a324de03c7 100644 --- a/specification/support/resource-manager/readme.md +++ b/specification/support/resource-manager/readme.md @@ -127,7 +127,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-sdk-for-go - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_support'] diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index 157cf8e116b8..8890b4cf7bd9 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -352,7 +352,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-js - repo: azure-sdk-for-java - repo: azure-sdk-for-python diff --git a/specification/trafficmanager/resource-manager/readme.md b/specification/trafficmanager/resource-manager/readme.md index 4a9a3761f740..9be7a7026c6d 100644 --- a/specification/trafficmanager/resource-manager/readme.md +++ b/specification/trafficmanager/resource-manager/readme.md @@ -199,7 +199,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-libraries-for-java - repo: azure-sdk-for-go diff --git a/specification/videoanalyzer/data-plane/readme.md b/specification/videoanalyzer/data-plane/readme.md index f93c32b77f84..913636375d2c 100644 --- a/specification/videoanalyzer/data-plane/readme.md +++ b/specification/videoanalyzer/data-plane/readme.md @@ -67,7 +67,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## C# diff --git a/specification/voiceservices/resource-manager/readme.md b/specification/voiceservices/resource-manager/readme.md index e04965a5e490..65654f41aa53 100644 --- a/specification/voiceservices/resource-manager/readme.md +++ b/specification/voiceservices/resource-manager/readme.md @@ -81,7 +81,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas - repo: azure-cli-extensions - repo: azure-powershell diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 3439fcbf43ec..e67674c58645 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -2643,7 +2643,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/webpubsub/data-plane/readme.md b/specification/webpubsub/data-plane/readme.md index 40c7969ad221..aeb2d423eee9 100644 --- a/specification/webpubsub/data-plane/readme.md +++ b/specification/webpubsub/data-plane/readme.md @@ -106,7 +106,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net ``` ## C# diff --git a/specification/webpubsub/resource-manager/readme.md b/specification/webpubsub/resource-manager/readme.md index ca542b263d85..f37efdf4565f 100644 --- a/specification/webpubsub/resource-manager/readme.md +++ b/specification/webpubsub/resource-manager/readme.md @@ -209,7 +209,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-node diff --git a/specification/workloadmonitor/resource-manager/readme.md b/specification/workloadmonitor/resource-manager/readme.md index 2e6a3d20d26f..a6a8aa642094 100644 --- a/specification/workloadmonitor/resource-manager/readme.md +++ b/specification/workloadmonitor/resource-manager/readme.md @@ -79,7 +79,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/readme.md b/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/readme.md index 06e6cfb1df22..57bd47c644a1 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/readme.md +++ b/specification/workloads/resource-manager/Microsoft.Workloads/SAPDiscoverySites/readme.md @@ -67,7 +67,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas - repo: azure-cli-extensions ``` diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/connectors/readme.md b/specification/workloads/resource-manager/Microsoft.Workloads/connectors/readme.md index 95af59023c16..aace64d8bf21 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/connectors/readme.md +++ b/specification/workloads/resource-manager/Microsoft.Workloads/connectors/readme.md @@ -57,7 +57,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas - repo: azure-cli-extensions ``` diff --git a/specification/workloads/resource-manager/readme.md b/specification/workloads/resource-manager/readme.md index d1159abb7dd4..c32dd4673412 100644 --- a/specification/workloads/resource-manager/readme.md +++ b/specification/workloads/resource-manager/readme.md @@ -82,7 +82,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js - - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-net - repo: azure-resource-manager-schemas - repo: azure-cli-extensions ``` From 84f223e8bea800a1a0b503b8c28675abf91f92a2 Mon Sep 17 00:00:00 2001 From: Isaac Sarek Banner <70341725+isaacbanner@users.noreply.github.com> Date: Fri, 24 Jan 2025 08:59:40 -0800 Subject: [PATCH 40/74] Add API version 2024-11-30 with support for isolationScope on user assigned identities. (#31443) * Copy files from stable/2023-01-31 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Copy stable/2023-01-31 to stable/2024-11-30 * Add new optional isolationScope extensible enum to UAMI api object * Nothing better than arbitrary style guidelines that fail my PR for changes made by the repo's own automated tooling * Clean up examples * Prettier everything, because the PR validation doesn't show all the errors the first time * Remove double-slash --- .../stable/2024-11-30/ManagedIdentity.json | 954 ++++++++++++++++++ .../FederatedIdentityCredentialCreate.json | 48 + .../FederatedIdentityCredentialDelete.json | 13 + .../FederatedIdentityCredentialGet.json | 25 + .../FederatedIdentityCredentialList.json | 30 + .../2024-11-30/examples/IdentityCreate.json | 53 + .../2024-11-30/examples/IdentityDelete.json | 12 + .../2024-11-30/examples/IdentityGet.json | 28 + .../examples/IdentityListByResourceGroup.json | 32 + .../examples/IdentityListBySubscription.json | 31 + .../2024-11-30/examples/IdentityUpdate.json | 38 + .../examples/MsiOperationsList.json | 41 + .../examples/SystemAssignedIdentityGet.json | 22 + specification/msi/resource-manager/readme.md | 11 +- 14 files changed, 1337 insertions(+), 1 deletion(-) create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/ManagedIdentity.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialCreate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialDelete.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialGet.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialList.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityCreate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityDelete.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityGet.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListByResourceGroup.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListBySubscription.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityUpdate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/MsiOperationsList.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/SystemAssignedIdentityGet.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/ManagedIdentity.json new file mode 100644 index 000000000000..b85bfc3160d0 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/ManagedIdentity.json @@ -0,0 +1,954 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-11-30", + "title": "ManagedServiceIdentityClient", + "description": "The Managed Service Identity Client." + }, + "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" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.ManagedIdentity/identities/default": { + "get": { + "operationId": "SystemAssignedIdentities_GetByScope", + "description": "Gets the systemAssignedIdentity available under the specified RP scope.", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/SystemAssignedIdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The systemAssignedIdentity was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/SystemAssignedIdentity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.ManagedIdentity/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.ManagedIdentity provider", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/MsiOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListBySubscription", + "description": "Lists all the userAssignedIdentities available under the specified subscription.", + "x-ms-examples": { + "IdentityListBySubscription": { + "$ref": "./examples/IdentityListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListByResourceGroup", + "description": "Lists all the userAssignedIdentities available under the specified ResourceGroup.", + "x-ms-examples": { + "IdentityListByResourceGroup": { + "$ref": "./examples/IdentityListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}": { + "put": { + "operationId": "UserAssignedIdentities_CreateOrUpdate", + "description": "Create or update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityCreate": { + "$ref": "./examples/IdentityCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Identity" + }, + "description": "Parameters to create or update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "201": { + "description": "Created identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "UserAssignedIdentities_Update", + "description": "Update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityUpdate": { + "$ref": "./examples/IdentityUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityUpdate" + }, + "description": "Parameters to update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "UserAssignedIdentities_Get", + "description": "Gets the identity.", + "x-ms-examples": { + "IdentityGet": { + "$ref": "./examples/IdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested identity.", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "UserAssignedIdentities_Delete", + "description": "Deletes the identity.", + "x-ms-examples": { + "IdentityDelete": { + "$ref": "./examples/IdentityDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted Identity." + }, + "204": { + "description": "The specified identity does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials": { + "get": { + "operationId": "FederatedIdentityCredentials_List", + "description": "Lists all the federated identity credentials under the specified user assigned identity.", + "x-ms-examples": { + "FederatedIdentityCredentialList": { + "$ref": "./examples/FederatedIdentityCredentialList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TopQueryParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of federated identity credentials for the specified user assigned identity was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredentialsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}": { + "put": { + "operationId": "FederatedIdentityCredentials_CreateOrUpdate", + "description": "Create or update a federated identity credential under the specified user assigned identity.", + "x-ms-examples": { + "FederatedIdentityCredentialCreate": { + "$ref": "./examples/FederatedIdentityCredentialCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + }, + "description": "Parameters to create or update the federated identity credential." + } + ], + "responses": { + "200": { + "description": "Updated federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "201": { + "description": "Created federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "FederatedIdentityCredentials_Get", + "description": "Gets the federated identity credential.", + "x-ms-examples": { + "FederatedIdentityCredentialGet": { + "$ref": "./examples/FederatedIdentityCredentialGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "FederatedIdentityCredentials_Delete", + "description": "Deletes the federated identity credential.", + "x-ms-examples": { + "FederatedIdentityCredentialDelete": { + "$ref": "./examples/FederatedIdentityCredentialDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted federated identity credential." + }, + "204": { + "description": "The specified federated identity credential does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Identity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes an identity resource." + }, + "FederatedIdentityCredential": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties associated with the federated identity credential.", + "$ref": "#/definitions/FederatedIdentityCredentialProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a federated identity credential." + }, + "IdentityUpdate": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/Resource" + } + ], + "description": "Describes an identity resource." + }, + "SystemAssignedIdentity": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/SystemAssignedIdentityProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a system assigned identity resource." + }, + "SystemAssignedIdentityProperties": { + "description": "The properties associated with the system assigned identity.", + "type": "object", + "title": "System Assigned Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + }, + "clientSecretUrl": { + "type": "string", + "readOnly": true, + "description": " The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials." + } + } + }, + "UserAssignedIdentityProperties": { + "description": "The properties associated with the user assigned identity.", + "type": "object", + "title": "User Assigned Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + }, + "isolationScope": { + "type": "string", + "description": "Enum to configure regional restrictions on identity assignment, as necessary.", + "enum": [ + "None", + "Regional" + ], + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "x-ms-enum": { + "name": "isolationScope", + "modelAsString": true, + "modelAsExtensible": true + } + } + } + }, + "FederatedIdentityCredentialProperties": { + "description": "The properties associated with a federated identity credential.", + "type": "object", + "title": "Federated identity credential properties.", + "required": [ + "issuer", + "subject", + "audiences" + ], + "properties": { + "issuer": { + "type": "string", + "format": "uri", + "description": "The URL of the issuer to be trusted." + }, + "subject": { + "type": "string", + "description": "The identifier of the external identity." + }, + "audiences": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of audiences that can appear in the issued token." + } + } + }, + "FederatedIdentityCredentialsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FederatedIdentityCredential" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "The collection of federated identity credentials returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation for federated identity credentials." + }, + "UserAssignedIdentitiesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Identity" + }, + "description": "The collection of userAssignedIdentities returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "A list of additional details about the error.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "Operation": { + "title": "Microsoft.ManagedIdentity Operation.", + "description": "Operation supported by the Microsoft.ManagedIdentity REST API.", + "type": "object", + "properties": { + "name": { + "title": "Operation Name.", + "description": "The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Resource Provider Name.", + "description": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "Operation Type.", + "description": "The type of operation. For example: read, write, delete.", + "type": "string" + }, + "resource": { + "title": "Resource Type.", + "description": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "Operation description", + "description": "A description of the operation.", + "type": "string" + } + } + }, + "OperationListResult": { + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider." + }, + "nextLink": { + "type": "string", + "title": "Next Link", + "description": "The url to get the next page of results, if any." + } + } + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The resource provider scope of the resource. Parent resource being extended by Managed Identities.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Id of the Subscription to which the identity belongs.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Resource Group to which the identity belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "description": "The name of the identity resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string" + }, + "TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to return.", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "SkipTokenParameter": { + "in": "query", + "name": "$skiptoken", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FederatedIdentityCredentialResourceNameParameter": { + "name": "federatedIdentityCredentialResourceName", + "in": "path", + "description": "The name of the federated identity credential resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{2,119}$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialCreate.json new file mode 100644 index 000000000000..d4d3bbae04b3 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName", + "parameters": { + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + }, + "200": { + "body": { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialDelete.json new file mode 100644 index 000000000000..19ed887f365f --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialGet.json new file mode 100644 index 000000000000..a0a4f1081a75 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialList.json new file mode 100644 index 000000000000..95caa1f4aa6a --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/FederatedIdentityCredentialList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "top": "20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + ], + "nextLink": "https://serviceRoot/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2024-11-30&$skipToken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityCreate.json new file mode 100644 index 000000000000..2a692c880cc5 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969", + "isolationScope": "None" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969", + "isolationScope": "None" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityDelete.json new file mode 100644 index 000000000000..8907854b8bb5 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityGet.json new file mode 100644 index 000000000000..2130f81afb1e --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969", + "isolationScope": "None" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListByResourceGroup.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListByResourceGroup.json new file mode 100644 index 000000000000..361b643493ab --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969", + "isolationScope": "None" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2024-11-30&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListBySubscription.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListBySubscription.json new file mode 100644 index 000000000000..4b1754c34fe8 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969", + "isolationScope": "Regional" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2024-11-30&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityUpdate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityUpdate.json new file mode 100644 index 000000000000..69e4562a89cf --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/IdentityUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "isolationScope": "Regional" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969", + "isolationScope": "Regional" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/MsiOperationsList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/MsiOperationsList.json new file mode 100644 index 000000000000..02e63cee6320 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/MsiOperationsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-11-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets an existing user assigned identity", + "operation": "Get User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/read" + }, + { + "display": { + "description": "Creates a new user assigned identity or updates the tags associated with an existing user assigned identity", + "operation": "Create/Update User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/write" + }, + { + "display": { + "description": "Deletes an existing user assigned identity", + "operation": "Delete User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/delete" + } + ], + "nextLink": "https://serviceRoot/providers/Microsoft.ManagedIdentity/operations?api-version=2024-11-30&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/SystemAssignedIdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/SystemAssignedIdentityGet.json new file mode 100644 index 000000000000..a1c29f460b73 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2024-11-30/examples/SystemAssignedIdentityGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-11-30", + "scope": "subscriptions/subId/resourceGroups/resourceGroupName/providers/Resource.Provider/resourceType/resourceName/identities/default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/resourceGroupName/providers/Resource.Provider/resourceType/resourceName/identities/default", + "location": "cus", + "name": "resourceName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "clientSecretUrl": "https://serviceRoot/subscriptions/subId/resourceGroups/resourceGroupName/providers/Resource.Provider/resourceType/resourceName/identities/default/credentials/v2/identities?tid=tenantId&arpid=guid&said=clientId", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "type": "ResourceProvider" + } + } + } +} diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index dd133e95e2af..8e7c1443cb3d 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Managed Service Identity API. ``` yaml openapi-type: arm -tag: package-2023-01-31 +tag: package-2024-11-30 +``` + +### Tag: package-2024-11-30 + +These settings apply only when `--tag=package-2024-11-30` is specified on the command line. + +```yaml $(tag) == 'package-2024-11-30' +input-file: + - Microsoft.ManagedIdentity/stable/2024-11-30/ManagedIdentity.json ``` ### Tag: package-2023-07-31-preview From 8559214e63b75aad2e35e0d8f986e8755172953b Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Fri, 24 Jan 2025 12:48:26 -0800 Subject: [PATCH 41/74] Sparse checkout 1espt auto-baselining file by default (#32316) Co-authored-by: Ben Broderick Phillips --- eng/common/pipelines/templates/steps/sparse-checkout.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/eng/common/pipelines/templates/steps/sparse-checkout.yml b/eng/common/pipelines/templates/steps/sparse-checkout.yml index 9e3cc3164abf..49ba3000df32 100644 --- a/eng/common/pipelines/templates/steps/sparse-checkout.yml +++ b/eng/common/pipelines/templates/steps/sparse-checkout.yml @@ -86,7 +86,10 @@ steps: # Set non-cone mode otherwise path filters will not work in git >= 2.37.0 # See https://github.blog/2022-06-27-highlights-from-git-2-37/#tidbits - git sparse-checkout set --no-cone '/*' '!/*/' '/eng' + # '/*' '!/*/' -> only checkout files in top level directory + # '/eng' -> checkout required eng/ scripts/configs + # '.config' -> required for files like .config/1espt/PipelineAutobaseliningConfig.yml and .config/guardian/.gdnbaselines used by 1es PT scripts + git sparse-checkout set --no-cone '/*' '!/*/' '/eng' '/.config' } # Prevent wildcard expansion in Invoke-Expression (e.g. for checkout path '/*') From ffa149a9e348ce22e5f50d607c768457a25c0022 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Fri, 24 Jan 2025 13:58:31 -0800 Subject: [PATCH 42/74] Sync eng/common directory with azure-sdk-tools for PR 9687 (#32305) * Migrate stress storage cluster * Add tenant to stress deploy login --------- Co-authored-by: Ben Broderick Phillips --- .../stress-testing/deploy-stress-tests.ps1 | 1 + .../stress-testing/stress-test-deployment-lib.ps1 | 15 +++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/eng/common/scripts/stress-testing/deploy-stress-tests.ps1 b/eng/common/scripts/stress-testing/deploy-stress-tests.ps1 index 61d8f947d800..76e0de20b7dd 100644 --- a/eng/common/scripts/stress-testing/deploy-stress-tests.ps1 +++ b/eng/common/scripts/stress-testing/deploy-stress-tests.ps1 @@ -10,6 +10,7 @@ param( [string]$DeployId, [switch]$SkipLogin, [string]$Subscription, + [string]$Tenant, # Default to true in Azure Pipelines environments [switch] $CI = ($null -ne $env:SYSTEM_TEAMPROJECTID), diff --git a/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 b/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 index 56876ba0e1be..498d4418fad9 100644 --- a/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 +++ b/eng/common/scripts/stress-testing/stress-test-deployment-lib.ps1 @@ -43,12 +43,12 @@ function RunOrExitOnFailure() } } -function Login([string]$subscription, [string]$clusterGroup, [switch]$skipPushImages) +function Login([string]$subscription, [string]$tenant, [string]$clusterGroup, [switch]$skipPushImages) { Write-Host "Logging in to subscription, cluster and container registry" az account show -s "$subscription" *> $null if ($LASTEXITCODE) { - RunOrExitOnFailure az login --allow-no-subscriptions + RunOrExitOnFailure az login --allow-no-subscriptions --tenant $tenant } # Discover cluster name, only one cluster per group is expected @@ -116,24 +116,27 @@ function DeployStressTests( } $clusterGroup = 'rg-stress-cluster-pg' $subscription = 'Azure SDK Developer Playground' + $tenant = '72f988bf-86f1-41af-91ab-2d7cd011db47' } elseif ($environment -eq 'prod') { if ($clusterGroup -or $subscription) { Write-Warning "Overriding cluster group and subscription with defaults for 'prod' environment." } $clusterGroup = 'rg-stress-cluster-prod' $subscription = 'Azure SDK Test Resources - TME' + $tenant = '70a036f6-8e4d-4615-bad6-149c02e7720d' } elseif ($environment -eq 'storage') { if ($clusterGroup -or $subscription) { Write-Warning "Overriding cluster group and subscription with defaults for 'storage' environment." } $clusterGroup = 'rg-stress-cluster-storage' - $subscription = 'XClient' - } elseif (!$clusterGroup -or !$subscription) { - throw "clusterGroup and subscription parameters must be specified when deploying to an environment that is not pg or prod." + $subscription = 'Azure SDK Test Resources - TME' + $tenant = '72f988bf-86f1-41af-91ab-2d7cd011db47' + } elseif (!$clusterGroup -or !$subscription -or $tenant) { + throw "-ClusterGroup, -Subscription and -Tenant parameters must be specified when deploying to an environment that is not pg or prod." } if (!$skipLogin) { - Login -subscription $subscription -clusterGroup $clusterGroup -skipPushImages:$skipPushImages + Login -subscription $subscription -tenant $tenant -clusterGroup $clusterGroup -skipPushImages:$skipPushImages } $chartRepoName = 'stress-test-charts' From 4744046cdc26b7e60ba4615bc79dc1fdfce4ea71 Mon Sep 17 00:00:00 2001 From: Rick Winter Date: Fri, 24 Jan 2025 17:02:15 -0800 Subject: [PATCH 43/74] Adding Rust crate information to Key Vault typespec (#32335) --- .../keyvault/Security.KeyVault.Certificates/tspconfig.yaml | 4 ++++ specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml b/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml index 000cc439daf1..cc9b8a8287c2 100644 --- a/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml @@ -61,3 +61,7 @@ options: single-client: true api-version: "7.5" inject-spans: true + "@azure-tools/typespec-rust": + crate-name: "azure_security_keyvault_certificates" + crate-version: "0.0.1" + emitter-output-dir: "{project-root}/generated" diff --git a/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml b/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml index 22cc2fd15249..0b1ae2f7292f 100644 --- a/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml @@ -61,3 +61,7 @@ options: single-client: true api-version: "7.5" inject-spans: true + "@azure-tools/typespec-rust": + crate-name: "azure_security_keyvault_keys" + crate-version: "0.0.1" + emitter-output-dir: "{project-root}/generated" From af55a114a62c5df3d00ba1ee80ef572ec8af9792 Mon Sep 17 00:00:00 2001 From: Mitchell Gale Date: Sat, 25 Jan 2025 18:01:38 -0800 Subject: [PATCH 44/74] Azure Data Factory PostgreSQL Entra Support updated (#31791) * adding aad to linkedservice for synapse and datafactory * pretty json * Update LinkedService.json * Update LinkedService.json * Update LinkedService.json * Update LinkedService.json * Update LinkedService.json * Update JSON references from datafactory to artifacts * removing postgresql synapse changes for non azure connector --------- Co-authored-by: Mitchell Gale --- .../2018-06-01/entityTypes/LinkedService.json | 36 +++++++++++++++++++ .../2020-12-01/entityTypes/LinkedService.json | 32 +++++++++++++++++ 2 files changed, 68 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 3cf564cb43d7..a9ef194e9006 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4970,6 +4970,42 @@ "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." + }, + "servicePrincipalId": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "servicePrincipalCredentialType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalEmbeddedCert": { + "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCertPassword": { + "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../datafactory.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 403d0ce8056e..fab5d99ea959 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -4501,6 +4501,38 @@ "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" + }, + "servicePrincipalId": { + "type": "object", + "description": "The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalCredentialType": { + "type": "object", + "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." + }, + "servicePrincipalEmbeddedCert": { + "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCertPassword": { + "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "tenant": { + "type": "object", + "description": "The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string)." + }, + "azureCloudType": { + "type": "object", + "description": "Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string)." + }, + "credential": { + "$ref": "../artifacts.json#/definitions/CredentialReference", + "description": "The credential reference containing authentication information." } } }, From fcd685f94e38a7daf9fb93b6f0c9eb9fd4eebe0d Mon Sep 17 00:00:00 2001 From: Frey-Wang Date: Sun, 26 Jan 2025 11:05:02 +0800 Subject: [PATCH 45/74] Support more teradata connection properties and teradata sink (#32229) * Support more teradata connection properties and teradata sink * fix spelling * remove additional properties * update description * update property --- .../2018-06-01/entityTypes/LinkedService.json | 32 ++++++++++++++++++- .../2018-06-01/entityTypes/Pipeline.json | 31 ++++++++++++++++++ .../2020-12-01/entityTypes/LinkedService.json | 24 ++++++++++++++ .../2020-12-01/entityTypes/Pipeline.json | 30 +++++++++++++++++ 4 files changed, 116 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index a9ef194e9006..b965038415ba 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2231,7 +2231,7 @@ "type": "object", "properties": { "connectionString": { - "description": "Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "description": "Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only applied for version 1.0.", "type": "object", "x-ms-format": "dfe-string" }, @@ -2261,6 +2261,36 @@ "description": "Password for authentication.", "$ref": "../datafactory.json#/definitions/SecretBase" }, + "sslMode": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "SSL mode for connection. Valid values including: “Disable”, “Allow”, “Prefer”, “Require”, “Verify-CA”, “Verify-Full”. Default value is “Verify-Full”. Type: string (or Expression with resultType string). Only applied for version 2.0." + }, + "portNumber": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0." + }, + "httpsPortNumber": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0." + }, + "useDataEncryption": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0." + }, + "characterSet": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0." + }, + "maxRespSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied for version 2.0." + }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index e1161baae473..f2b29e708077 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -3288,6 +3288,37 @@ } } }, + "TeradataSink": { + "description": "A copy activity Teradata sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "importSettings": { + "$ref": "#/definitions/TeradataImportCommand", + "description": "Teradata import settings." + } + } + }, + "TeradataImportCommand": { + "description": "Teradata import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "additionalFormatOptions": { + "type": "object", + "x-ms-format": "dfe-key-value-pairs", + "description": "Additional format options for Teradata Copy Command. The format options only applies to direct copy from CSV source. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"timeFormat\": \"HHhMImSSs\" }" + } + } + }, "TeradataPartitionSettings": { "description": "The settings that will be leveraged for teradata source partitioning.", "type": "object", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index fab5d99ea959..5ae198ee350b 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -1972,6 +1972,30 @@ "description": "Password for authentication.", "$ref": "../artifacts.json#/definitions/SecretBase" }, + "sslMode": { + "type": "object", + "description": "SSL mode for connection. Valid values including: “Disable”, “Allow”, “Prefer”, “Require”, “Verify-CA”, “Verify-Full”. Default value is “Verify-Full”. Type: string (or Expression with resultType string). Only applied for version 2.0." + }, + "portNumber": { + "type": "object", + "description": "The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0." + }, + "httpsPortNumber": { + "type": "object", + "description": "The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0." + }, + "useDataEncryption": { + "type": "object", + "description": "Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0." + }, + "characterSet": { + "type": "object", + "description": "The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0." + }, + "maxRespSize": { + "type": "object", + "description": "The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied for version 2.0." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 21b1cd6e075d..a928fad73188 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -2881,6 +2881,36 @@ } } }, + "TeradataSink": { + "description": "A copy activity Teradata sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "importSettings": { + "$ref": "#/definitions/TeradataImportCommand", + "description": "Teradata import settings." + } + } + }, + "TeradataImportCommand": { + "description": "Teradata import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "additionalFormatOptions": { + "type": "object", + "description": "Additional format options for Teradata Copy Command. The format options only applies to direct copy from CSV source. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: \"additionalFormatOptions\": { \"timeFormat\": \"HHhMImSSs\" }" + } + } + }, "WebSource": { "description": "A copy activity source for web page table.", "type": "object", From 709b04cc3d7bd62058bbf7c5c76e5a7fd1126fa9 Mon Sep 17 00:00:00 2001 From: Yao Kou Date: Sun, 26 Jan 2025 13:43:42 +0800 Subject: [PATCH 46/74] [DataFactory & Synapse] Update Oracle Linked Service (#32060) * update Oracle linked service * minor change * fix spell check * update description * update properties to camel case * revert cspell change to test * bring spell check back * fix * fix spell error --------- Co-authored-by: Mike Harder --- specification/datafactory/cspell.yaml | 1 + .../2018-06-01/entityTypes/LinkedService.json | 80 ++++++++++++++++++- specification/synapse/cspell.yaml | 1 + .../2020-12-01/entityTypes/LinkedService.json | 67 +++++++++++++++- 4 files changed, 145 insertions(+), 4 deletions(-) diff --git a/specification/datafactory/cspell.yaml b/specification/datafactory/cspell.yaml index 94920b8aa156..eb2958246930 100644 --- a/specification/datafactory/cspell.yaml +++ b/specification/datafactory/cspell.yaml @@ -39,6 +39,7 @@ words: - vsts - wtgctbg - xero + - tswtz overrides: - filename: >- **/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index b965038415ba..dc37333650c9 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -1655,7 +1655,7 @@ }, "OracleLinkedService": { "x-ms-discriminator-value": "Oracle", - "description": "Oracle database.", + "description": "Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.", "type": "object", "allOf": [ { @@ -1680,12 +1680,88 @@ "connectionString": { "type": "object", "x-ms-format": "dfe-string", - "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference." + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0." + }, + "server": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0." + }, + "authenticationType": { + "type": "string", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "OracleAuthenticationType", + "modelAsString": true + }, + "description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0." + }, + "username": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The Oracle database username. Type: string. Only used for Version 2.0." }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, + "encryptionClient": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." + }, + "encryptionTypesClient": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0." + }, + "cryptoChecksumClient": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." + }, + "cryptoChecksumTypesClient": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0." + }, + "initialLobFetchSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0." + }, + "fetchSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0." + }, + "statementCacheSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0." + }, + "initializationString": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0." + }, + "enableBulkLoad": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0." + }, + "supportV1DataTypes": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0." + }, + "fetchTswtzAsTimestamp": { + "type": "object", + "x-ms-format": "dfe-bool", + "description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0." + }, "encryptedCredential": { "type": "string", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string." diff --git a/specification/synapse/cspell.yaml b/specification/synapse/cspell.yaml index cd27ab39db99..5504235058f6 100644 --- a/specification/synapse/cspell.yaml +++ b/specification/synapse/cspell.yaml @@ -65,6 +65,7 @@ words: - wtgctbg - xero - xlargerc + - tswtz overrides: - filename: >- **/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 5ae198ee350b..b9ca3af51b42 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -1412,7 +1412,7 @@ }, "OracleLinkedService": { "x-ms-discriminator-value": "Oracle", - "description": "Oracle database.", + "description": "Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.", "type": "object", "allOf": [ { @@ -1435,13 +1435,76 @@ "type": "object", "properties": { "connectionString": { - "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", + "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.", "type": "object" }, + "server": { + "type": "object", + "description": "The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0." + }, + "authenticationType": { + "type": "string", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "OracleAuthenticationType", + "modelAsString": true + }, + "description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0." + }, + "username": { + "type": "object", + "description": "The Oracle database username. Type: string. Only used for Version 2.0." + }, "password": { "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, + "encryptionClient": { + "type": "object", + "description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." + }, + "encryptionTypesClient": { + "type": "object", + "description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0." + }, + "cryptoChecksumClient": { + "type": "object", + "description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0." + }, + "cryptoChecksumTypesClient": { + "type": "object", + "description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0." + }, + "initialLobFetchSize": { + "type": "object", + "description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0." + }, + "fetchSize": { + "type": "object", + "description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0." + }, + "statementCacheSize": { + "type": "object", + "description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0." + }, + "initializationString": { + "type": "object", + "description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0." + }, + "enableBulkLoad": { + "type": "object", + "description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0." + }, + "supportV1DataTypes": { + "type": "object", + "description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0." + }, + "fetchTswtzAsTimestamp": { + "type": "object", + "description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." From fe05a52a88972b1e90a7bfe4c2ecff8cc9d36427 Mon Sep 17 00:00:00 2001 From: Jayati Tehri <72947097+jayati-tehri@users.noreply.github.com> Date: Mon, 27 Jan 2025 09:30:29 -0800 Subject: [PATCH 47/74] Adding missing property (#32261) --- .../stable/2023-09-01/costmanagement.pricesheets.json | 5 +++++ .../stable/2023-11-01/costmanagement.pricesheets.json | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-09-01/costmanagement.pricesheets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-09-01/costmanagement.pricesheets.json index c0cc8c04bf8c..ca5de7617fdd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-09-01/costmanagement.pricesheets.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-09-01/costmanagement.pricesheets.json @@ -330,6 +330,11 @@ "type": "string", "readOnly": true }, + "meterId": { + "description": "Unique identifier of the meter ", + "type": "string", + "readOnly": true + }, "meterName": { "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", "type": "string", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json index ce78ad9ee9a4..0507f61ee0d1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json @@ -330,6 +330,11 @@ "type": "string", "readOnly": true }, + "meterId": { + "description": "Unique identifier of the meter ", + "type": "string", + "readOnly": true + }, "meterName": { "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", "type": "string", From bb9db37f6542f55284f3189ffbf4717005159ffe Mon Sep 17 00:00:00 2001 From: Albert Cheng <38804567+ckairen@users.noreply.github.com> Date: Mon, 27 Jan 2025 10:39:38 -0800 Subject: [PATCH 48/74] [TypeSpec APIView] Ensure apiview only triggers on packages directly changed by the pr (#31871) * get typespec project * fix dir path * test * fix source and target branch * adjust to pr comment * decrease log size * get changed files * git suggestion changes * Trigger Build * testing for 2 dirs * Update specification/confidentialledger/Microsoft.ManagedCcf/transactions.tsp * testing for 2 dirs * baseline file destination bug fix * better path modification * Update specification/contosowidgetmanager/Contoso.WidgetManager/main.tsp * Update specification/contosowidgetmanager/Contoso.Management/employee.tsp --- eng/scripts/Create-APIView.ps1 | 66 +++++++++++++++++++++++++++++----- 1 file changed, 58 insertions(+), 8 deletions(-) diff --git a/eng/scripts/Create-APIView.ps1 b/eng/scripts/Create-APIView.ps1 index f8bea35af231..e1bb0e15add1 100644 --- a/eng/scripts/Create-APIView.ps1 +++ b/eng/scripts/Create-APIView.ps1 @@ -86,6 +86,33 @@ function Get-ResourceProviderFromReadMePath { return $null } +function Get-ImpactedTypespecProjects { + param ( + [Parameter(Mandatory = $true)] + [string]$TypeSpecFile + ) + $it = $TypeSpecFile + while ($it -and !$configFilesInTypeSpecProjects) { + $it = Split-Path -Parent $it + $configFilesInTypeSpecProjects = Get-ChildItem -Path $it -File "tspconfig.yaml" + } + + if ($configFilesInTypeSpecProjects) { + foreach($configFilesInTypeSpecProject in $configFilesInTypeSpecProjects) { + $maintsp = Get-ChildItem -Path $($configFilesInTypeSpecProject.Directory.FullName) -File "main.tsp" + $clienttsp = Get-ChildItem -Path $($configFilesInTypeSpecProject.Directory.FullName) -File "client.tsp" + $entryPointFile = $maintsp ? $maintsp : $clienttsp + if ($entryPointFile) { + Write-Host "Found $($configFilesInTypeSpecProject.Name) and $($entryPointFile.Name) in directory $($configFilesInTypeSpecProject.Directory.FullName)" + return $configFilesInTypeSpecProject.Directory.FullName + } + else { + Write-Host "Did not find main.tsp nor client.tsp in directory $($configFilesInTypeSpecProject.Directory.FullName)" + } + } + } +} + <# .DESCRIPTION Invoke the swagger parset to generate APIView tokens. @@ -366,12 +393,30 @@ function New-TypeSpecAPIViewTokens { $SourceCommitId = $(git rev-parse HEAD^2) $TargetCommitId = $(git rev-parse HEAD^1) - $typeSpecProjects, $null = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" ` - -IgnoreCoreFiles:$true ` - -BaseCommitish:$SourceCommitId ` - -TargetCommitish:$TargetCommitId + LogInfo " Getting changed TypeSpec files in PR, between $SourceCommitId and $TargetCommitId" + $changedFiles = Get-ChangedFiles + $changedTypeSpecFiles = Get-ChangedTypeSpecFiles -changedFiles $changedFiles + + if ($changedTypeSpecFiles.Count -eq 0) { + LogWarning " There are no changes to TypeSpec files in the current PR..." + Write-Host "##vso[task.complete result=SucceededWithIssues;]DONE" + exit 0 + } - $typeSpecProjects = $typeSpecProjects | Where-Object {Test-Path -Path "$_/main.tsp"} + LogGroupStart " Pullrequest has changes in these TypeSpec files..." + $changedTypeSpecFiles | ForEach-Object { + LogInfo " - $_" + } + LogGroupEnd + + # Get impacted TypeSpec projects + $typeSpecProjects = [System.Collections.Generic.HashSet[string]]::new() + $changedTypeSpecFiles | ForEach-Object { + $tspProj = Get-ImpactedTypespecProjects -TypeSpecFile "$_" + if ($tspProj) { + $typeSpecProjects.Add($tspProj) | Out-Null + } + } LogGroupStart " TypeSpec APIView Tokens will be generated for the following configuration files..." $typeSpecProjects | ForEach-Object { @@ -391,25 +436,30 @@ function New-TypeSpecAPIViewTokens { git checkout $SourceCommitId Write-Host "Installing required dependencies to generate New API review" npm ci + LogGroupStart "npm ls -a" npm ls -a + LogGroupEnd foreach ($typeSpecProject in $typeSpecProjects) { - $tokenDirectory = [System.IO.Path]::Combine($typeSpecAPIViewArtifactsDirectory, $typeSpecProject.split([IO.Path]::DirectorySeparatorChar)[-1]) + $tokenDirectory = Join-Path $typeSpecAPIViewArtifactsDirectory $(Split-Path $typeSpecProject -Leaf) New-Item -ItemType Directory -Path $tokenDirectory -Force | Out-Null - Invoke-TypeSpecAPIViewParser -Type "New" -ProjectPath $typeSpecProject -ResourceProvider $($typeSpecProject.split([IO.Path]::DirectorySeparatorChar)[-1]) -TokenDirectory $tokenDirectory + Invoke-TypeSpecAPIViewParser -Type "New" -ProjectPath $typeSpecProject -ResourceProvider $(Split-Path $typeSpecProject -Leaf) -TokenDirectory $tokenDirectory } # Generate Baseline TypeSpec APIView Tokens git checkout $TargetCommitId Write-Host "Installing required dependencies to generate Baseline API review" npm ci + LogGroupStart "npm ls -a" npm ls -a + LogGroupEnd foreach ($typeSpecProject in $typeSpecProjects) { # Skip Baseline APIView Token for new projects if (!(Test-Path -Path $typeSpecProject)) { Write-Host "TypeSpec project $typeSpecProject is not found in pull request target branch. API review will not have a baseline revision." } else { - Invoke-TypeSpecAPIViewParser -Type "Baseline" -ProjectPath $typeSpecProject -ResourceProvider $($typeSpecProject.split([IO.Path]::DirectorySeparatorChar)[-1]) -TokenDirectory $tokenDirectory | Out-Null + $tokenDirectory = Join-Path $typeSpecAPIViewArtifactsDirectory $(Split-Path $typeSpecProject -Leaf) + Invoke-TypeSpecAPIViewParser -Type "Baseline" -ProjectPath $typeSpecProject -ResourceProvider $(Split-Path $typeSpecProject -Leaf) -TokenDirectory $tokenDirectory | Out-Null } } } From f8e906707f0bed0609606370ad33de50546f8c63 Mon Sep 17 00:00:00 2001 From: Jacky Lui <84883957+jackylui-ms@users.noreply.github.com> Date: Mon, 27 Jan 2025 11:34:00 -0800 Subject: [PATCH 49/74] Microsoft.DevOpsInfrastructure 2025-01-21 (#32241) * up * example * add ephemeral type * example * example --- .../2025-01-21/CreateOrUpdatePool.json | 140 ++ .../examples/2025-01-21/DeletePool.json | 18 + .../examples/2025-01-21/GetPool.json | 45 + .../2025-01-21/ImageVersions_ListByImage.json | 27 + .../examples/2025-01-21/ListOperations.json | 12 + .../2025-01-21/ListPoolsBySubscription.json | 20 + ...stPoolsBySubscriptionAndResourceGroup.json | 21 + .../Pools_CheckNameAvailability.json | 22 + .../ResourceDetails_ListByPool.json | 37 + .../2025-01-21/Sku_ListByLocation.json | 278 +++ .../2025-01-21/SubscriptionUsages_Usages.json | 38 + .../examples/2025-01-21/UpdatePool.json | 23 + .../main.tsp | 39 +- .../2025-01-21/devopsinfrastructure.json | 2210 +++++++++++++++++ .../examples/CreateOrUpdatePool.json | 140 ++ .../2025-01-21/examples/DeletePool.json | 18 + .../stable/2025-01-21/examples/GetPool.json | 45 + .../examples/ImageVersions_ListByImage.json | 27 + .../2025-01-21/examples/ListOperations.json | 12 + .../examples/ListPoolsBySubscription.json | 20 + ...stPoolsBySubscriptionAndResourceGroup.json | 21 + .../examples/Pools_CheckNameAvailability.json | 22 + .../examples/ResourceDetails_ListByPool.json | 37 + .../examples/Sku_ListByLocation.json | 278 +++ .../examples/SubscriptionUsages_Usages.json | 38 + .../2025-01-21/examples/UpdatePool.json | 23 + .../resource-manager/readme.md | 11 +- 27 files changed, 3619 insertions(+), 3 deletions(-) create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/CreateOrUpdatePool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/DeletePool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/GetPool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ImageVersions_ListByImage.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListOperations.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscription.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscriptionAndResourceGroup.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Pools_CheckNameAvailability.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ResourceDetails_ListByPool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Sku_ListByLocation.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/SubscriptionUsages_Usages.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/UpdatePool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/devopsinfrastructure.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/CreateOrUpdatePool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/DeletePool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/GetPool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ImageVersions_ListByImage.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListOperations.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscription.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscriptionAndResourceGroup.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Pools_CheckNameAvailability.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ResourceDetails_ListByPool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Sku_ListByLocation.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/SubscriptionUsages_Usages.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/CreateOrUpdatePool.json new file mode 100644 index 000000000000..dbec637591ab --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/CreateOrUpdatePool.json @@ -0,0 +1,140 @@ +{ + "title": "Pools_CreateOrUpdate", + "operationId": "Pools_CreateOrUpdate", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "resource": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com", + "openAccess": true + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest", + "ephemeralType": "Automatic" + } + ], + "osProfile": { + "secretsManagementSettings": { + "certificateStoreName": "Root", + "observedCertificates": [ + "https://abc.vault.azure.net/secrets/one" + ], + "keyExportable": false + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ], + "osProfile": { + "secretsManagementSettings": { + "certificateStoreName": "Root", + "observedCertificates": [ + "https://abc.vault.azure.net/secrets/one" + ], + "keyExportable": false + } + } + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ], + "osProfile": { + "secretsManagementSettings": { + "certificateStoreName": "Root", + "observedCertificates": [ + "https://abc.vault.azure.net/secrets/one" + ], + "keyExportable": false + } + } + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/DeletePool.json new file mode 100644 index 000000000000..d743fe811ed4 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/DeletePool.json @@ -0,0 +1,18 @@ +{ + "title": "Pools_Delete", + "operationId": "Pools_Delete", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/GetPool.json new file mode 100644 index 000000000000..aa7c300dbfe0 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Pools_Get", + "operationId": "Pools_Get", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ImageVersions_ListByImage.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ImageVersions_ListByImage.json new file mode 100644 index 000000000000..2e0d78fdaa14 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ImageVersions_ListByImage.json @@ -0,0 +1,27 @@ +{ + "title": "ImageVersions_ListByImage", + "operationId": "ImageVersions_ListByImage", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "imageName": "windows-2022" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.0", + "name": "2024.0417.0" + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.1", + "name": "2024.0417.1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListOperations.json new file mode 100644 index 000000000000..de2893750302 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListOperations.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-01-21" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscription.json new file mode 100644 index 000000000000..c092ab9ff2f2 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscription.json @@ -0,0 +1,20 @@ +{ + "title": "Pools_ListBySubscription", + "operationId": "Pools_ListBySubscription", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/aoiresourceGroupName/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..939ee5047ca2 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ListPoolsBySubscriptionAndResourceGroup.json @@ -0,0 +1,21 @@ +{ + "title": "Pools_ListByResourceGroup", + "operationId": "Pools_ListByResourceGroup", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Pools_CheckNameAvailability.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Pools_CheckNameAvailability.json new file mode 100644 index 000000000000..a942cee46f0f --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Pools_CheckNameAvailability.json @@ -0,0 +1,22 @@ +{ + "title": "Pools_CheckNameAvailability", + "operationId": "Pools_CheckNameAvailability", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "api-version": "2025-01-21", + "body": { + "name": "mydevopspool", + "type": "Microsoft.DevOpsInfrastructure/pools" + } + }, + "responses": { + "200": { + "body": { + "available": "Unavailable", + "message": "Managed DevOps pool mydevopspool is already in use. Please choose a pool name that has not been taken.", + "name": "mydevopspool", + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ResourceDetails_ListByPool.json new file mode 100644 index 000000000000..87f4415373dd --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/ResourceDetails_ListByPool.json @@ -0,0 +1,37 @@ +{ + "title": "ResourceDetails_ListByPool", + "operationId": "ResourceDetails_ListByPool", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "poolName": "my-dev-ops-pool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_0", + "name": "dd8cc705c000000", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Ready" + } + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_1", + "name": "dd8cc705c000001", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Allocated" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Sku_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Sku_ListByLocation.json new file mode 100644 index 000000000000..2d2f5e36032e --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/Sku_ListByLocation.json @@ -0,0 +1,278 @@ +{ + "title": "Sku_ListByLocation", + "operationId": "Sku_ListByLocation", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "locationName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Basic", + "size": "A0", + "family": "basicAFamily", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "MaxDataDiskCount", + "value": "1" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "50" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [ + { + "type": "Location", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ] + }, + "reasonCode": "NotAvailableForSubscription" + }, + { + "type": "Zone", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ], + "zones": [ + "1", + "2", + "3" + ] + }, + "reasonCode": "NotAvailableForSubscription" + } + ] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Basic_A0", + "name": "Basic_A0" + }, + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Standard", + "size": "A2_v2", + "family": "standardAv2Family", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [ + "1", + "2", + "3" + ], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "2" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "4" + }, + { + "name": "MaxDataDiskCount", + "value": "4" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "True" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "PaaS,IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "2" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "CombinedTempDiskAndCachedIOPS", + "value": "2000" + }, + { + "name": "CombinedTempDiskAndCachedReadBytesPerSecond", + "value": "41943040" + }, + { + "name": "CombinedTempDiskAndCachedWriteBytesPerSecond", + "value": "20971520" + }, + { + "name": "UncachedDiskIOPS", + "value": "3200" + }, + { + "name": "UncachedDiskBytesPerSecond", + "value": "48000000" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "True" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Standard_A2_v2", + "name": "Standard_A2_v2" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/SubscriptionUsages_Usages.json new file mode 100644 index 000000000000..cb949dacbedb --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/SubscriptionUsages_Usages.json @@ -0,0 +1,38 @@ +{ + "title": "SubscriptionUsages_Usages", + "operationId": "SubscriptionUsages_Usages", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "location": "eastus", + "api-version": "2025-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 212, + "name": { + "value": "standardDADSv5Family", + "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 100, + "name": { + "value": "standardDPLDSv5Family", + "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/UpdatePool.json new file mode 100644 index 000000000000..c6e7a532ebb7 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2025-01-21/UpdatePool.json @@ -0,0 +1,23 @@ +{ + "title": "Pools_Update", + "operationId": "Pools_Update", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "properties": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp index 97b46faeb286..dcae61cf5117 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp @@ -21,10 +21,10 @@ namespace Microsoft.DevOpsInfrastructure; /** Api versions */ enum Versions { - /** 2024-10-19 version */ + /** 2025-01-21 version */ @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_2) - `2024-10-19`, + `2025-01-21`, } model Pool is TrackedResource { @@ -98,6 +98,7 @@ model AzureDevOpsOrganizationProfile extends OrganizationProfile { @doc("The type of permission which determines which accounts are admins on the Azure DevOps pool.") permissionProfile?: AzureDevOpsPermissionProfile; } + @doc("Defines an Azure DevOps organization.") model Organization { @doc("The Azure DevOps organization URL in which the pool should be created.") @@ -108,6 +109,9 @@ model Organization { @doc("How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool.") parallelism?: int32; + + @doc("Determines if the pool should have open access to all projects in this organization.") + openAccess?: boolean; } @doc("Defines the type of Azure DevOps pool permission.") model AzureDevOpsPermissionProfile { @@ -240,6 +244,20 @@ union OsDiskStorageAccountType { StandardSSD: "StandardSSD", } +@doc("The type of Ephemeral option the pool will use on underlying VMs when loading this image.") +union EphemeralType { + string, + + @doc("Ephemeral is handled by Managed DevOps Pools service.") + Automatic: "Automatic", + + @doc("CacheDisk ephemeral only, requires that the SKU has a cache that is large enough for the image.") + CacheDisk: "CacheDisk", + + @doc("ResourceDisk ephemeral only, requires only that the SKU supports it.") + ResourceDisk: "ResourceDisk", +} + @doc("The VM image of the machines in the pool.") model PoolImage { @doc("The resource id of the image.") @@ -253,6 +271,9 @@ model PoolImage { @doc("The percentage of the buffer to be allocated to this image.") buffer?: string = "*"; + + @doc("The ephemeral type of the image.") + ephemeralType?: EphemeralType; } @doc("The OS profile of the machines in the pool.") @@ -264,11 +285,25 @@ model OsProfile { logonType?: LogonType; } +@doc("The certificate store name type") +union CertificateStoreNameOption { + string, + + @doc("The X.509 certificate store for personal certificates.") + "My", + + @doc("The X.509 certificate store for trusted root certificate authorities (CAs).") + "Root", +} + @doc("The secret management settings of the machines in the pool.") model SecretsManagementSettings { @doc("Where to store certificates on the machine.") certificateStoreLocation?: string; + @doc("Name of the certificate store to use on the machine, currently 'My' and 'Root' are supported.") + certificateStoreName?: CertificateStoreNameOption; + @doc("The list of certificates to install on all machines in the pool.") observedCertificates: url[]; diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/devopsinfrastructure.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/devopsinfrastructure.json new file mode 100644 index 000000000000..86e73f29ec4d --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/devopsinfrastructure.json @@ -0,0 +1,2210 @@ +{ + "swagger": "2.0", + "info": { + "title": "Managed DevOps Infrastructure", + "version": "2025-01-21", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Pools" + }, + { + "name": "ResourceDetails" + }, + { + "name": "Sku" + }, + { + "name": "SubscriptionUsages" + }, + { + "name": "ImageVersions" + } + ], + "paths": { + "/providers/Microsoft.DevOpsInfrastructure/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/checkNameAvailability": { + "post": { + "operationId": "Pools_CheckNameAvailability", + "tags": [ + "Pools" + ], + "description": "Checks that the pool name is valid and is not already in use.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_CheckNameAvailability": { + "$ref": "./examples/Pools_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{locationName}/skus": { + "get": { + "operationId": "Sku_ListByLocation", + "tags": [ + "Sku" + ], + "description": "List ResourceSku resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Sku_ListByLocation": { + "$ref": "./examples/Sku_ListByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{location}/usages": { + "get": { + "operationId": "SubscriptionUsages_Usages", + "tags": [ + "SubscriptionUsages" + ], + "description": "List Quota resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SubscriptionUsages_Usages": { + "$ref": "./examples/SubscriptionUsages_Usages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/pools": { + "get": { + "operationId": "Pools_ListBySubscription", + "tags": [ + "Pools" + ], + "description": "List Pool resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_ListBySubscription": { + "$ref": "./examples/ListPoolsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/images/{imageName}/versions": { + "get": { + "operationId": "ImageVersions_ListByImage", + "tags": [ + "ImageVersions" + ], + "description": "List ImageVersion resources by Image", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "imageName", + "in": "path", + "description": "Name of the image.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByImage": { + "$ref": "./examples/ImageVersions_ListByImage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools": { + "get": { + "operationId": "Pools_ListByResourceGroup", + "tags": [ + "Pools" + ], + "description": "List Pool resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_ListByResourceGroup": { + "$ref": "./examples/ListPoolsBySubscriptionAndResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}": { + "get": { + "operationId": "Pools_Get", + "tags": [ + "Pools" + ], + "description": "Get a Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "./examples/GetPool.json" + } + } + }, + "put": { + "operationId": "Pools_CreateOrUpdate", + "tags": [ + "Pools" + ], + "description": "Create a Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Pool' update operation succeeded", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "201": { + "description": "Resource 'Pool' create operation succeeded", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "./examples/CreateOrUpdatePool.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Pools_Update", + "tags": [ + "Pools" + ], + "description": "Update a Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "./examples/UpdatePool.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Pools_Delete", + "tags": [ + "Pools" + ], + "description": "Delete a Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "./examples/DeletePool.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}/resources": { + "get": { + "operationId": "ResourceDetails_ListByPool", + "tags": [ + "ResourceDetails" + ], + "description": "List ResourceDetailsObject resources by Pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceDetailsObjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResourceDetails_ListByPool": { + "$ref": "./examples/ResourceDetails_ListByPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AgentProfile": { + "type": "object", + "description": "The agent profile of the machines in the pool.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for AgentProfile." + }, + "resourcePredictions": { + "$ref": "#/definitions/ResourcePredictions", + "description": "Defines pool buffer/stand-by agents." + }, + "resourcePredictionsProfile": { + "$ref": "#/definitions/ResourcePredictionsProfile", + "description": "Defines how the pool buffer/stand-by agents is provided." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AutomaticResourcePredictionsProfile": { + "type": "object", + "description": "The stand-by agent scheme is determined based on historical demand.", + "properties": { + "predictionPreference": { + "$ref": "#/definitions/PredictionPreference", + "description": "Determines the balance between cost and performance." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourcePredictionsProfile" + } + ], + "x-ms-discriminator-value": "Automatic" + }, + "AvailabilityStatus": { + "type": "string", + "description": "AvailabilityStatus of a name.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AvailabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available", + "description": "The name is available." + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "The name is unavailable" + } + ] + } + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "AzureDevOpsOrganizationProfile": { + "type": "object", + "description": "Azure DevOps organization profile", + "properties": { + "organizations": { + "type": "array", + "description": "The list of Azure DevOps organizations the pool should be present in.", + "items": { + "$ref": "#/definitions/Organization" + }, + "x-ms-identifiers": [] + }, + "permissionProfile": { + "$ref": "#/definitions/AzureDevOpsPermissionProfile", + "description": "The type of permission which determines which accounts are admins on the Azure DevOps pool." + } + }, + "required": [ + "organizations" + ], + "allOf": [ + { + "$ref": "#/definitions/OrganizationProfile" + } + ], + "x-ms-discriminator-value": "AzureDevOps" + }, + "AzureDevOpsPermissionProfile": { + "type": "object", + "description": "Defines the type of Azure DevOps pool permission.", + "properties": { + "kind": { + "$ref": "#/definitions/AzureDevOpsPermissionType", + "description": "Determines who has admin permissions to the Azure DevOps pool." + }, + "users": { + "type": "array", + "description": "User email addresses", + "items": { + "type": "string" + } + }, + "groups": { + "type": "array", + "description": "Group email addresses", + "items": { + "type": "string" + } + } + }, + "required": [ + "kind" + ] + }, + "AzureDevOpsPermissionType": { + "type": "string", + "description": "Determines who has admin permissions to the Azure DevOps pool.", + "enum": [ + "Inherit", + "CreatorOnly", + "SpecificAccounts" + ], + "x-ms-enum": { + "name": "AzureDevOpsPermissionType", + "modelAsString": true, + "values": [ + { + "name": "Inherit", + "value": "Inherit", + "description": "Pool will inherit permissions from the project or organization." + }, + { + "name": "CreatorOnly", + "value": "CreatorOnly", + "description": "Only the pool creator will be an admin of the pool." + }, + { + "name": "SpecificAccounts", + "value": "SpecificAccounts", + "description": "Only the specified accounts will be admins of the pool." + } + ] + } + }, + "CachingType": { + "type": "string", + "description": "The type of caching in a data disk.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Don't use host caching." + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "For workloads that only do read operations." + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "For workloads that do a balance of read and write operations." + } + ] + } + }, + "CertificateStoreNameOption": { + "type": "string", + "description": "The certificate store name type", + "enum": [ + "My", + "Root" + ], + "x-ms-enum": { + "name": "CertificateStoreNameOption", + "modelAsString": true, + "values": [ + { + "name": "My", + "value": "My", + "description": "The X.509 certificate store for personal certificates." + }, + { + "name": "Root", + "value": "Root", + "description": "The X.509 certificate store for trusted root certificate authorities (CAs)." + } + ] + } + }, + "CheckNameAvailability": { + "type": "object", + "description": "The parameters used to check the availability of a resource.", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "type": { + "$ref": "#/definitions/DevOpsInfrastructureResourceType", + "description": "The type of resource that is used as the scope of the availability check." + } + }, + "required": [ + "name", + "type" + ] + }, + "CheckNameAvailabilityReason": { + "type": "string", + "description": "The reason code explaining why the name is unavailable. Will be null if the name is available.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "CheckNameAvailabilityReason", + "modelAsString": true, + "values": [ + { + "name": "Invalid", + "value": "Invalid", + "description": "The name is invalid." + }, + { + "name": "AlreadyExists", + "value": "AlreadyExists", + "description": "The name already exists." + } + ] + } + }, + "CheckNameAvailabilityResult": { + "type": "object", + "description": "The CheckNameAvailability operation response.", + "properties": { + "available": { + "$ref": "#/definitions/AvailabilityStatus", + "description": "Availability status of the name." + }, + "message": { + "type": "string", + "description": "A message explaining why the name is unavailable. Will be null if the name is available." + }, + "name": { + "type": "string", + "description": "The name whose availability was checked." + }, + "reason": { + "$ref": "#/definitions/CheckNameAvailabilityReason", + "description": "The reason code explaining why the name is unavailable. Will be null if the name is available." + } + }, + "required": [ + "available", + "message", + "name", + "reason" + ] + }, + "DataDisk": { + "type": "object", + "description": "The data disk of the VMSS.", + "properties": { + "caching": { + "$ref": "#/definitions/CachingType", + "description": "The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGiB": { + "type": "integer", + "format": "int32", + "description": "The initial disk size in gigabytes." + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "The storage Account type to be used for the data disk. If omitted, the default is \"standard_lrs\"." + }, + "driveLetter": { + "type": "string", + "description": "The drive letter for the empty data disk. If not specified, it will be the first available letter." + } + } + }, + "DevOpsAzureSku": { + "type": "object", + "description": "The Azure SKU of the machines in the pool.", + "properties": { + "name": { + "type": "string", + "description": "The Azure SKU name of the machines in the pool." + } + }, + "required": [ + "name" + ] + }, + "DevOpsInfrastructureResourceType": { + "type": "string", + "description": "The type of resource.", + "enum": [ + "Microsoft.DevOpsInfrastructure/pools" + ], + "x-ms-enum": { + "name": "DevOpsInfrastructureResourceType", + "modelAsString": true, + "values": [ + { + "name": "Microsoft.DevOpsInfrastructure/pools", + "value": "Microsoft.DevOpsInfrastructure/pools", + "description": "DevOpsInfrastructure pool resource." + } + ] + } + }, + "EphemeralType": { + "type": "string", + "description": "The type of Ephemeral option the pool will use on underlying VMs when loading this image.", + "enum": [ + "Automatic", + "CacheDisk", + "ResourceDisk" + ], + "x-ms-enum": { + "name": "EphemeralType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Ephemeral is handled by Managed DevOps Pools service." + }, + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "CacheDisk ephemeral only, requires that the SKU has a cache that is large enough for the image." + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "ResourceDisk ephemeral only, requires only that the SKU supports it." + } + ] + } + }, + "FabricProfile": { + "type": "object", + "description": "Defines the type of fabric the agent will run on.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for FabricProfile." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "GitHubOrganization": { + "type": "object", + "description": "Defines a GitHub organization", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The GitHub organization URL in which the pool should be created." + }, + "repositories": { + "type": "array", + "description": "Optional list of repositories in which the pool should be created.", + "items": { + "type": "string" + } + } + }, + "required": [ + "url" + ] + }, + "GitHubOrganizationProfile": { + "type": "object", + "description": "GitHub organization profile", + "properties": { + "organizations": { + "type": "array", + "description": "The list of GitHub organizations/repositories the pool should be present in.", + "items": { + "$ref": "#/definitions/GitHubOrganization" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "organizations" + ], + "allOf": [ + { + "$ref": "#/definitions/OrganizationProfile" + } + ], + "x-ms-discriminator-value": "GitHub" + }, + "ImageVersion": { + "type": "object", + "description": "An image version object", + "properties": { + "properties": { + "$ref": "#/definitions/ImageVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImageVersionListResult": { + "type": "object", + "description": "The response of a ImageVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImageVersion items on this page", + "items": { + "$ref": "#/definitions/ImageVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImageVersionProperties": { + "type": "object", + "description": "Details of the ImageVersionProperties.", + "properties": { + "version": { + "type": "string", + "description": "Version of the image." + } + }, + "required": [ + "version" + ] + }, + "LogonType": { + "type": "string", + "description": "Determines how the service should be run.", + "enum": [ + "Service", + "Interactive" + ], + "x-ms-enum": { + "name": "LogonType", + "modelAsString": true, + "values": [ + { + "name": "Service", + "value": "Service", + "description": "Run as a service." + }, + { + "name": "Interactive", + "value": "Interactive", + "description": "Run in interactive mode." + } + ] + } + }, + "ManualResourcePredictionsProfile": { + "type": "object", + "description": "Customer provides the stand-by agent scheme.", + "allOf": [ + { + "$ref": "#/definitions/ResourcePredictionsProfile" + } + ], + "x-ms-discriminator-value": "Manual" + }, + "NetworkProfile": { + "type": "object", + "description": "The network profile of the machines in the pool.", + "properties": { + "subnetId": { + "type": "string", + "description": "The subnet id on which to put all machines created in the pool." + } + }, + "required": [ + "subnetId" + ] + }, + "Organization": { + "type": "object", + "description": "Defines an Azure DevOps organization.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The Azure DevOps organization URL in which the pool should be created." + }, + "projects": { + "type": "array", + "description": "Optional list of projects in which the pool should be created.", + "items": { + "type": "string" + } + }, + "parallelism": { + "type": "integer", + "format": "int32", + "description": "How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool." + }, + "openAccess": { + "type": "boolean", + "description": "Determines if the pool should have open access to all projects in this organization." + } + }, + "required": [ + "url" + ] + }, + "OrganizationProfile": { + "type": "object", + "description": "Defines the organization in which the pool will be used.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for OrganizationProfile." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "OsDiskStorageAccountType": { + "type": "string", + "description": "The storage account type of the OS disk.", + "enum": [ + "Standard", + "Premium", + "StandardSSD" + ], + "x-ms-enum": { + "name": "OsDiskStorageAccountType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard OS disk type." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium OS disk type." + }, + { + "name": "StandardSSD", + "value": "StandardSSD", + "description": "Standard SSD OS disk type." + } + ] + } + }, + "OsProfile": { + "type": "object", + "description": "The OS profile of the machines in the pool.", + "properties": { + "secretsManagementSettings": { + "$ref": "#/definitions/SecretsManagementSettings", + "description": "The secret management settings of the machines in the pool." + }, + "logonType": { + "$ref": "#/definitions/LogonType", + "description": "Determines how the service should be run. By default, this will be set to Service." + } + } + }, + "PagedQuota": { + "type": "object", + "description": "Paged collection of Quota items", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Pool": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/PoolProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "PoolImage": { + "type": "object", + "description": "The VM image of the machines in the pool.", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of the image." + }, + "wellKnownImageName": { + "type": "string", + "description": "The image to use from a well-known set of images made available to customers." + }, + "aliases": { + "type": "array", + "description": "List of aliases to reference the image by.", + "items": { + "type": "string" + } + }, + "buffer": { + "type": "string", + "description": "The percentage of the buffer to be allocated to this image.", + "default": "*" + }, + "ephemeralType": { + "$ref": "#/definitions/EphemeralType", + "description": "The ephemeral type of the image." + } + } + }, + "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" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PoolProperties": { + "type": "object", + "description": "Pool properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the current operation." + }, + "maximumConcurrency": { + "type": "integer", + "format": "int32", + "description": "Defines how many resources can there be created at any given time.", + "minimum": 1, + "maximum": 10000 + }, + "organizationProfile": { + "$ref": "#/definitions/OrganizationProfile", + "description": "Defines the organization in which the pool will be used." + }, + "agentProfile": { + "$ref": "#/definitions/AgentProfile", + "description": "Defines how the machine will be handled once it executed a job." + }, + "fabricProfile": { + "$ref": "#/definitions/FabricProfile", + "description": "Defines the type of fabric the agent will run on." + }, + "devCenterProjectResourceId": { + "type": "string", + "description": "The resource id of the DevCenter Project the pool belongs to." + } + }, + "required": [ + "maximumConcurrency", + "organizationProfile", + "agentProfile", + "fabricProfile", + "devCenterProjectResourceId" + ] + }, + "PoolUpdate": { + "type": "object", + "description": "The type used for update operations of the Pool.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PoolUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "PoolUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Pool.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the current operation." + }, + "maximumConcurrency": { + "type": "integer", + "format": "int32", + "description": "Defines how many resources can there be created at any given time.", + "minimum": 1, + "maximum": 10000 + }, + "organizationProfile": { + "$ref": "#/definitions/OrganizationProfile", + "description": "Defines the organization in which the pool will be used." + }, + "agentProfile": { + "$ref": "#/definitions/AgentProfile", + "description": "Defines how the machine will be handled once it executed a job." + }, + "fabricProfile": { + "$ref": "#/definitions/FabricProfile", + "description": "Defines the type of fabric the agent will run on." + }, + "devCenterProjectResourceId": { + "type": "string", + "description": "The resource id of the DevCenter Project the pool belongs to." + } + } + }, + "PredictionPreference": { + "type": "string", + "description": "Determines the balance between cost and performance.", + "enum": [ + "Balanced", + "MostCostEffective", + "MoreCostEffective", + "MorePerformance", + "BestPerformance" + ], + "x-ms-enum": { + "name": "PredictionPreference", + "modelAsString": true, + "values": [ + { + "name": "Balanced", + "value": "Balanced", + "description": "Balance between cost and performance." + }, + { + "name": "MostCostEffective", + "value": "MostCostEffective", + "description": "Optimizes for cost over performance." + }, + { + "name": "MoreCostEffective", + "value": "MoreCostEffective", + "description": "Halfway through cost and balanced." + }, + { + "name": "MorePerformance", + "value": "MorePerformance", + "description": "Halfway through balanced and performance." + }, + { + "name": "BestPerformance", + "value": "BestPerformance", + "description": "Optimizes for performance over cost." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Represents a succeeded operation." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Represents a failed operation." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Represents a canceled operation." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Represents a pending operation." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Represents a pending operation." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Represents an operation under deletion." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Represents an accepted operation." + } + ] + } + }, + "Quota": { + "type": "object", + "description": "Describes Resource Quota", + "properties": { + "name": { + "$ref": "#/definitions/QuotaName", + "description": "The name of the quota.", + "readOnly": true + }, + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ARM resource id" + }, + "unit": { + "type": "string", + "description": "The unit of usage measurement." + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + } + }, + "required": [ + "id", + "unit", + "currentValue", + "limit" + ] + }, + "QuotaName": { + "type": "object", + "description": "The Quota Names", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + } + }, + "ResourceDetailsObject": { + "type": "object", + "description": "A ResourceDetailsObject", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceDetailsObjectProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResourceDetailsObjectListResult": { + "type": "object", + "description": "The response of a ResourceDetailsObject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceDetailsObject items on this page", + "items": { + "$ref": "#/definitions/ResourceDetailsObject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ResourceDetailsObjectProperties": { + "type": "object", + "description": "Details of the ResourceDetailsObject.", + "properties": { + "status": { + "$ref": "#/definitions/ResourceStatus", + "description": "The status of the resource." + }, + "image": { + "type": "string", + "description": "The image name of the resource." + }, + "imageVersion": { + "type": "string", + "description": "The version of the image running on the resource." + } + }, + "required": [ + "status", + "image", + "imageVersion" + ] + }, + "ResourcePredictions": { + "type": "object", + "description": "Defines pool buffer." + }, + "ResourcePredictionsProfile": { + "type": "object", + "description": "Determines how the stand-by scheme should be provided.", + "properties": { + "kind": { + "$ref": "#/definitions/ResourcePredictionsProfileType", + "description": "Determines how the stand-by scheme should be provided." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "ResourcePredictionsProfileType": { + "type": "string", + "description": "Determines how the stand-by scheme should be provided.", + "enum": [ + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "ResourcePredictionsProfileType", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "Customer provides the stand-by agent scheme." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "The stand-by agent scheme is determined based on historical demand." + } + ] + } + }, + "ResourceSku": { + "type": "object", + "description": "A ResourceSku", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceSkuProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResourceSkuCapabilities": { + "type": "object", + "description": "Describes The SKU capabilities object.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU capability." + }, + "value": { + "type": "string", + "description": "The value of the SKU capability." + } + }, + "required": [ + "name", + "value" + ] + }, + "ResourceSkuListResult": { + "type": "object", + "description": "The response of a ResourceSku list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceSku items on this page", + "items": { + "$ref": "#/definitions/ResourceSku" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ResourceSkuLocationInfo": { + "type": "object", + "description": "Describes an available Compute SKU Location Information.", + "properties": { + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Location of the SKU" + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is supported.", + "items": { + "type": "string" + } + }, + "zoneDetails": { + "type": "array", + "description": "Gets details of capabilities available to a SKU in specific zones.", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "location", + "zones", + "zoneDetails" + ] + }, + "ResourceSkuProperties": { + "type": "object", + "description": "Properties of a ResourceSku", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "tier": { + "type": "string", + "description": "The tier of virtual machines in a scale set" + }, + "size": { + "type": "string", + "description": "The size of the SKU." + }, + "family": { + "type": "string", + "description": "The family of the SKU." + }, + "locations": { + "type": "array", + "description": "The set of locations that the SKU is available.", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + }, + "locationInfo": { + "type": "array", + "description": "A list of locations and availability zones in those locations where the SKU is available", + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "x-ms-identifiers": [] + }, + "capabilities": { + "type": "array", + "description": "Name value pairs to describe the capability.", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "x-ms-identifiers": [] + }, + "restrictions": { + "type": "array", + "description": "The restrictions of the SKU.", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "resourceType", + "tier", + "size", + "family", + "locations", + "locationInfo", + "capabilities", + "restrictions" + ] + }, + "ResourceSkuRestrictionInfo": { + "type": "object", + "description": "Describes an available Compute SKU Restriction Information.", + "properties": { + "locations": { + "type": "array", + "description": "Locations where the SKU is restricted", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is restricted.", + "items": { + "type": "string" + } + } + } + }, + "ResourceSkuRestrictions": { + "type": "object", + "description": "The restrictions of the SKU.", + "properties": { + "type": { + "$ref": "#/definitions/ResourceSkuRestrictionsType", + "description": "the type of restrictions." + }, + "values": { + "type": "array", + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.", + "items": { + "type": "string" + } + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "$ref": "#/definitions/ResourceSkuRestrictionsReasonCode", + "description": "the reason for restriction." + } + }, + "required": [ + "values", + "restrictionInfo" + ] + }, + "ResourceSkuRestrictionsReasonCode": { + "type": "string", + "description": "Describes the reason for SKU restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true, + "values": [ + { + "name": "QuotaId", + "value": "QuotaId", + "description": "The restriction is due to exceeding a quota limitation." + }, + { + "name": "NotAvailableForSubscription", + "value": "NotAvailableForSubscription", + "description": "The restriction is not available for this subscription." + } + ] + } + }, + "ResourceSkuRestrictionsType": { + "type": "string", + "description": "Describes the kind of SKU restrictions that can exist", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": true, + "values": [ + { + "name": "Location", + "value": "Location", + "description": "SKU restricted by location." + }, + { + "name": "Zone", + "value": "Zone", + "description": "SKU restricted by availability zone." + } + ] + } + }, + "ResourceSkuZoneDetails": { + "type": "object", + "description": "Describes The zonal capabilities of a SKU.", + "properties": { + "name": { + "type": "array", + "description": "Gets the set of zones that the SKU is available in with the specified capabilities.", + "items": { + "type": "string" + } + }, + "capabilities": { + "type": "array", + "description": "A list of capabilities that are available for the SKU in the specified list of zones.", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "capabilities" + ] + }, + "ResourceStatus": { + "type": "string", + "description": "The status of the machine resource.", + "enum": [ + "Ready", + "NotReady", + "Allocated", + "PendingReturn", + "Returned", + "Leased", + "Provisioning", + "Updating", + "Starting", + "PendingReimage", + "Reimaging" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true, + "values": [ + { + "name": "Ready", + "value": "Ready", + "description": "Represents a machine resource that is ready." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Represents a machine resource that is not ready." + }, + { + "name": "Allocated", + "value": "Allocated", + "description": "Represents a machine resource that is allocated." + }, + { + "name": "PendingReturn", + "value": "PendingReturn", + "description": "Represents a machine resource that is pending return." + }, + { + "name": "Returned", + "value": "Returned", + "description": "Represents a machine resource that is returned." + }, + { + "name": "Leased", + "value": "Leased", + "description": "Represents a machine resource that is leased." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Represents a machine resource that is provisioning." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Represents a machine resource that is updating." + }, + { + "name": "Starting", + "value": "Starting", + "description": "Represents a machine resource that is starting." + }, + { + "name": "PendingReimage", + "value": "PendingReimage", + "description": "Represents a machine resource that is pending reimage." + }, + { + "name": "Reimaging", + "value": "Reimaging", + "description": "Represents a machine resource that is reimaging." + } + ] + } + }, + "SecretsManagementSettings": { + "type": "object", + "description": "The secret management settings of the machines in the pool.", + "properties": { + "certificateStoreLocation": { + "type": "string", + "description": "Where to store certificates on the machine." + }, + "certificateStoreName": { + "$ref": "#/definitions/CertificateStoreNameOption", + "description": "Name of the certificate store to use on the machine, currently 'My' and 'Root' are supported." + }, + "observedCertificates": { + "type": "array", + "description": "The list of certificates to install on all machines in the pool.", + "items": { + "type": "string", + "format": "uri" + } + }, + "keyExportable": { + "type": "boolean", + "description": "Defines if the key of the certificates should be exportable." + } + }, + "required": [ + "observedCertificates", + "keyExportable" + ] + }, + "Stateful": { + "type": "object", + "description": "Stateful profile meaning that the machines will be returned to the pool after running a job.", + "properties": { + "maxAgentLifetime": { + "type": "string", + "description": "How long should stateful machines be kept around. The maximum is one week." + }, + "gracePeriodTimeSpan": { + "type": "string", + "description": "How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AgentProfile" + } + ], + "x-ms-discriminator-value": "Stateful" + }, + "StatelessAgentProfile": { + "type": "object", + "description": "Stateless profile meaning that the machines will be cleaned up after running a job.", + "allOf": [ + { + "$ref": "#/definitions/AgentProfile" + } + ], + "x-ms-discriminator-value": "Stateless" + }, + "StorageAccountType": { + "type": "string", + "description": "StorageAccountType enums", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true, + "values": [ + { + "name": "StandardLRS", + "value": "Standard_LRS", + "description": "The data disk should use standard locally redundant storage." + }, + { + "name": "PremiumLRS", + "value": "Premium_LRS", + "description": "The data disk should use premium locally redundant storage." + }, + { + "name": "StandardSSDLRS", + "value": "StandardSSD_LRS", + "description": "The data disk should use standard SSD locally redundant storage." + }, + { + "name": "PremiumZRS", + "value": "Premium_ZRS", + "description": "The data disk should use premium SSD zonal redundant storage." + }, + { + "name": "StandardSSDZRS", + "value": "StandardSSD_ZRS", + "description": "The data disk should use standard SSD zonal redundant storage." + } + ] + } + }, + "StorageProfile": { + "type": "object", + "description": "The storage profile of the VMSS.", + "properties": { + "osDiskStorageAccountType": { + "$ref": "#/definitions/OsDiskStorageAccountType", + "description": "The Azure SKU name of the machines in the pool." + }, + "dataDisks": { + "type": "array", + "description": "A list of empty data disks to attach.", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [] + } + } + }, + "VmssFabricProfile": { + "type": "object", + "description": "The agents will run on Virtual Machine Scale Sets.", + "properties": { + "sku": { + "$ref": "#/definitions/DevOpsAzureSku", + "description": "The Azure SKU of the machines in the pool." + }, + "images": { + "type": "array", + "description": "The VM images of the machines in the pool.", + "items": { + "$ref": "#/definitions/PoolImage" + }, + "x-ms-identifiers": [] + }, + "osProfile": { + "$ref": "#/definitions/OsProfile", + "description": "The OS profile of the machines in the pool." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile of the machines in the pool." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "The network profile of the machines in the pool." + } + }, + "required": [ + "sku", + "images" + ], + "allOf": [ + { + "$ref": "#/definitions/FabricProfile" + } + ], + "x-ms-discriminator-value": "Vmss" + } + }, + "parameters": {} +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/CreateOrUpdatePool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/CreateOrUpdatePool.json new file mode 100644 index 000000000000..dbec637591ab --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/CreateOrUpdatePool.json @@ -0,0 +1,140 @@ +{ + "title": "Pools_CreateOrUpdate", + "operationId": "Pools_CreateOrUpdate", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "resource": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com", + "openAccess": true + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest", + "ephemeralType": "Automatic" + } + ], + "osProfile": { + "secretsManagementSettings": { + "certificateStoreName": "Root", + "observedCertificates": [ + "https://abc.vault.azure.net/secrets/one" + ], + "keyExportable": false + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ], + "osProfile": { + "secretsManagementSettings": { + "certificateStoreName": "Root", + "observedCertificates": [ + "https://abc.vault.azure.net/secrets/one" + ], + "keyExportable": false + } + } + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ], + "osProfile": { + "secretsManagementSettings": { + "certificateStoreName": "Root", + "observedCertificates": [ + "https://abc.vault.azure.net/secrets/one" + ], + "keyExportable": false + } + } + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/DeletePool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/DeletePool.json new file mode 100644 index 000000000000..d743fe811ed4 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/DeletePool.json @@ -0,0 +1,18 @@ +{ + "title": "Pools_Delete", + "operationId": "Pools_Delete", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/GetPool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/GetPool.json new file mode 100644 index 000000000000..aa7c300dbfe0 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Pools_Get", + "operationId": "Pools_Get", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ImageVersions_ListByImage.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ImageVersions_ListByImage.json new file mode 100644 index 000000000000..2e0d78fdaa14 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ImageVersions_ListByImage.json @@ -0,0 +1,27 @@ +{ + "title": "ImageVersions_ListByImage", + "operationId": "ImageVersions_ListByImage", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "imageName": "windows-2022" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.0", + "name": "2024.0417.0" + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.1", + "name": "2024.0417.1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListOperations.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListOperations.json new file mode 100644 index 000000000000..de2893750302 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListOperations.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-01-21" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscription.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscription.json new file mode 100644 index 000000000000..c092ab9ff2f2 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscription.json @@ -0,0 +1,20 @@ +{ + "title": "Pools_ListBySubscription", + "operationId": "Pools_ListBySubscription", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/aoiresourceGroupName/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..939ee5047ca2 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ListPoolsBySubscriptionAndResourceGroup.json @@ -0,0 +1,21 @@ +{ + "title": "Pools_ListByResourceGroup", + "operationId": "Pools_ListByResourceGroup", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Pools_CheckNameAvailability.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Pools_CheckNameAvailability.json new file mode 100644 index 000000000000..a942cee46f0f --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Pools_CheckNameAvailability.json @@ -0,0 +1,22 @@ +{ + "title": "Pools_CheckNameAvailability", + "operationId": "Pools_CheckNameAvailability", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "api-version": "2025-01-21", + "body": { + "name": "mydevopspool", + "type": "Microsoft.DevOpsInfrastructure/pools" + } + }, + "responses": { + "200": { + "body": { + "available": "Unavailable", + "message": "Managed DevOps pool mydevopspool is already in use. Please choose a pool name that has not been taken.", + "name": "mydevopspool", + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ResourceDetails_ListByPool.json new file mode 100644 index 000000000000..87f4415373dd --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/ResourceDetails_ListByPool.json @@ -0,0 +1,37 @@ +{ + "title": "ResourceDetails_ListByPool", + "operationId": "ResourceDetails_ListByPool", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "poolName": "my-dev-ops-pool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_0", + "name": "dd8cc705c000000", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Ready" + } + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_1", + "name": "dd8cc705c000001", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Allocated" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Sku_ListByLocation.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Sku_ListByLocation.json new file mode 100644 index 000000000000..2d2f5e36032e --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/Sku_ListByLocation.json @@ -0,0 +1,278 @@ +{ + "title": "Sku_ListByLocation", + "operationId": "Sku_ListByLocation", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "locationName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Basic", + "size": "A0", + "family": "basicAFamily", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "MaxDataDiskCount", + "value": "1" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "50" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [ + { + "type": "Location", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ] + }, + "reasonCode": "NotAvailableForSubscription" + }, + { + "type": "Zone", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ], + "zones": [ + "1", + "2", + "3" + ] + }, + "reasonCode": "NotAvailableForSubscription" + } + ] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Basic_A0", + "name": "Basic_A0" + }, + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Standard", + "size": "A2_v2", + "family": "standardAv2Family", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [ + "1", + "2", + "3" + ], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "2" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "4" + }, + { + "name": "MaxDataDiskCount", + "value": "4" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "True" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "PaaS,IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "2" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "CombinedTempDiskAndCachedIOPS", + "value": "2000" + }, + { + "name": "CombinedTempDiskAndCachedReadBytesPerSecond", + "value": "41943040" + }, + { + "name": "CombinedTempDiskAndCachedWriteBytesPerSecond", + "value": "20971520" + }, + { + "name": "UncachedDiskIOPS", + "value": "3200" + }, + { + "name": "UncachedDiskBytesPerSecond", + "value": "48000000" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "True" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Standard_A2_v2", + "name": "Standard_A2_v2" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/SubscriptionUsages_Usages.json new file mode 100644 index 000000000000..cb949dacbedb --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/SubscriptionUsages_Usages.json @@ -0,0 +1,38 @@ +{ + "title": "SubscriptionUsages_Usages", + "operationId": "SubscriptionUsages_Usages", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "location": "eastus", + "api-version": "2025-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 212, + "name": { + "value": "standardDADSv5Family", + "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 100, + "name": { + "value": "standardDPLDSv5Family", + "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/UpdatePool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/UpdatePool.json new file mode 100644 index 000000000000..c6e7a532ebb7 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2025-01-21/examples/UpdatePool.json @@ -0,0 +1,23 @@ +{ + "title": "Pools_Update", + "operationId": "Pools_Update", + "parameters": { + "api-version": "2025-01-21", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "properties": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/readme.md b/specification/devopsinfrastructure/resource-manager/readme.md index 59ce5fcfe4d0..906f7a39c396 100644 --- a/specification/devopsinfrastructure/resource-manager/readme.md +++ b/specification/devopsinfrastructure/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the devopsinfrastructure. ``` yaml openapi-type: arm openapi-subtype: providerHub -tag: package-stable-2024-10-19 +tag: package-stable-2025-01-21 ``` ``` yaml @@ -35,6 +35,15 @@ modelerfour: flatten-models: false ``` +### Tag: package-stable-2025-01-21 + +These settings apply only when `--tag=package-stable-2025-01-21` is specified on the command line. + +```yaml $(tag) == 'package-stable-2025-01-21' +input-file: + - Microsoft.DevOpsInfrastructure/stable/2025-01-21/devopsinfrastructure.json +``` + ### Tag: package-stable-2024-10-19 These settings apply only when `--tag=package-stable-2024-10-19` is specified on the command line. From b3d637043bcd1484f0f4c63ca6051407b6a329d1 Mon Sep 17 00:00:00 2001 From: ahhuss <60206064+ahhuss1@users.noreply.github.com> Date: Mon, 27 Jan 2025 12:21:42 -0800 Subject: [PATCH 50/74] Update readme.md for RPaaS (#32346) --- specification/storageactions/resource-manager/readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/storageactions/resource-manager/readme.md b/specification/storageactions/resource-manager/readme.md index 480e1f7cec58..2ae8ae7052d0 100644 --- a/specification/storageactions/resource-manager/readme.md +++ b/specification/storageactions/resource-manager/readme.md @@ -26,6 +26,7 @@ These are the global settings for the storageactions. ```yaml openapi-type: arm +openapi-subtype: rpaas tag: package-2023-01-01 ``` @@ -77,4 +78,4 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp -See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file +See configuration in [readme.csharp.md](./readme.csharp.md) From 16ec969d371722aa0d6ca821772da7bdb93db4c6 Mon Sep 17 00:00:00 2001 From: Libba Lawrence Date: Mon, 27 Jan 2025 13:19:06 -0800 Subject: [PATCH 51/74] [EG] maps required/optional (#30759) * maps * update value type --- .../Microsoft.Maps/Maps.tsp | 22 ++++++++++++------- .../2018-01-01/GeneratedSystemEvents.json | 10 +++++++-- .../2024-01-01/GeneratedSystemEvents.json | 14 ++++++++++-- 3 files changed, 34 insertions(+), 12 deletions(-) diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp index 9f8cbf7e7494..50152988bcd9 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Maps/Maps.tsp @@ -1,3 +1,5 @@ +import "@typespec/versioning"; +using TypeSpec.Versioning; /** Describes the schema of the Azure Maps events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent. */ namespace Microsoft.EventGrid.SystemEvents; @@ -16,34 +18,38 @@ model MapsGeofenceResultEventData extends MapsGeofenceEventProperties {} /** Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult). */ model MapsGeofenceEventProperties { /** Lists of the geometry ID of the geofence which is expired relative to the user time in the request. */ - expiredGeofenceGeometryId?: string[]; + expiredGeofenceGeometryId: string[]; /** Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence. */ geometries: MapsGeofenceGeometry[]; /** Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request. */ - invalidPeriodGeofenceGeometryId?: string[]; + invalidPeriodGeofenceGeometryId: string[]; /** True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. */ - isEventPublished?: boolean; + @madeRequired(ServiceApiVersions.v2024_01_01) + isEventPublished: boolean; } /** The geofence geometry. */ model MapsGeofenceGeometry { /** ID of the device. */ - deviceId?: string; + deviceId: string; /** Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence. */ - distance?: float32; + @madeRequired(ServiceApiVersions.v2024_01_01) + distance: float32; /** The unique ID for the geofence geometry. */ - geometryId?: string; + geometryId: string; /** Latitude of the nearest point of the geometry. */ - nearestLat?: float32; + @madeRequired(ServiceApiVersions.v2024_01_01) + nearestLat: float32; /** Longitude of the nearest point of the geometry. */ - nearestLon?: float32; + @madeRequired(ServiceApiVersions.v2024_01_01) + nearestLon: float32; /** The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API. */ udId?: string; diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json index 80d3cc641d94..8c65c271304c 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json @@ -6165,7 +6165,9 @@ } }, "required": [ - "geometries" + "expiredGeofenceGeometryId", + "geometries", + "invalidPeriodGeofenceGeometryId" ] }, "MapsGeofenceExitedEventData": { @@ -6208,7 +6210,11 @@ "type": "string", "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API." } - } + }, + "required": [ + "deviceId", + "geometryId" + ] }, "MapsGeofenceResultEventData": { "type": "object", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json index 6e5910e4a748..1b68e25e5b01 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json @@ -6282,7 +6282,10 @@ } }, "required": [ - "geometries" + "expiredGeofenceGeometryId", + "geometries", + "invalidPeriodGeofenceGeometryId", + "isEventPublished" ] }, "MapsGeofenceExitedEventData": { @@ -6325,7 +6328,14 @@ "type": "string", "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API." } - } + }, + "required": [ + "deviceId", + "distance", + "geometryId", + "nearestLat", + "nearestLon" + ] }, "MapsGeofenceResultEventData": { "type": "object", From 23202def50f87680141866766c62158f2bc82a31 Mon Sep 17 00:00:00 2001 From: Grace Wilcox <43627800+gracewilcox@users.noreply.github.com> Date: Mon, 27 Jan 2025 14:35:16 -0800 Subject: [PATCH 52/74] [Key Vault Secrets] go cleanup client.tsp (#32348) --- .../keyvault/Security.KeyVault.Secrets/client.tsp | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/specification/keyvault/Security.KeyVault.Secrets/client.tsp b/specification/keyvault/Security.KeyVault.Secrets/client.tsp index 8f2b3c2fa1ed..72a8f57976b7 100644 --- a/specification/keyvault/Security.KeyVault.Secrets/client.tsp +++ b/specification/keyvault/Security.KeyVault.Secrets/client.tsp @@ -9,11 +9,15 @@ using Azure.ClientGenerator.Core; using KeyVault; -@@clientName(SecretProperties, "SecretP", "go"); +// renaming SecretItem to SecretProperties. +// renaming existing SecretProperties to something else +// to avoid a naming conflict as it's not part of the public surface area +@@clientName(SecretProperties, "ShouldNotGenerate", "go"); +@@clientName(SecretItem, "SecretProperties", "go"); + @@clientName(DeletedSecretBundle, "DeletedSecret", "go"); @@clientName(DeletedSecretItem, "DeletedSecretProperties", "go"); @@clientName(SecretBundle, "Secret", "go"); -@@clientName(SecretItem, "SecretProperties", "go"); @@clientName(SecretRestoreParameters, "RestoreSecretParameters", "go"); @@clientName(SecretSetParameters, "SetSecretParameters", "go"); @@clientName(SecretUpdateParameters, "UpdateSecretPropertiesParameters", "go"); From 6e4d25df14bb5252d9911c9de2c8fc99a32e644d Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Mon, 27 Jan 2025 19:21:51 -0800 Subject: [PATCH 53/74] Sync eng/common directory with azure-sdk-tools for PR 9699 (#32351) * allow the indirect matrix to generate non-sparse based on new parameter to generate-job-matrix --------- Co-authored-by: Scott Beddall --- .../templates/jobs/generate-job-matrix.yml | 6 +++++- .../scripts/job-matrix/Create-PrJobMatrix.ps1 | 18 +++++++++++------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/eng/common/pipelines/templates/jobs/generate-job-matrix.yml b/eng/common/pipelines/templates/jobs/generate-job-matrix.yml index d1db47b30b22..7cb3a785cea5 100644 --- a/eng/common/pipelines/templates/jobs/generate-job-matrix.yml +++ b/eng/common/pipelines/templates/jobs/generate-job-matrix.yml @@ -54,6 +54,9 @@ parameters: - name: PRMatrixIndirectFilters type: object default: [] +- name: PRMatrixSparseIndirect + type: boolean + default: true # Mappings to OS name required at template compile time by 1es pipeline templates - name: Pools type: object @@ -142,7 +145,8 @@ jobs: -Filters '${{ join(''',''', parameters.MatrixFilters) }}', 'container=^$', 'SupportedClouds=^$|${{ parameters.CloudConfig.Cloud }}', 'Pool=${{ pool.filter }}' ` -IndirectFilters '${{ join(''',''', parameters.PRMatrixIndirectFilters) }}' ` -Replace '${{ join(''',''', parameters.MatrixReplace) }}' ` - -PackagesPerPRJob ${{ parameters.PRJobBatchSize }} + -PackagesPerPRJob ${{ parameters.PRJobBatchSize }} ` + -SparseIndirect $${{ parameters.PRMatrixSparseIndirect }} displayName: Create ${{ pool.name }} PR Matrix name: vm_job_matrix_pr_${{ pool.name }} diff --git a/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 b/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 index 8e18e2479ca4..805b2d934b3c 100644 --- a/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 +++ b/eng/common/scripts/job-matrix/Create-PrJobMatrix.ps1 @@ -44,6 +44,7 @@ param ( [Parameter(Mandatory = $False)][array] $Filters, [Parameter(Mandatory = $False)][array] $IndirectFilters, [Parameter(Mandatory = $False)][array] $Replace, + [Parameter(Mandatory = $False)][bool] $SparseIndirect = $true, [Parameter(Mandatory = $False)][int] $PackagesPerPRJob = 10, [Parameter()][switch] $CI = ($null -ne $env:SYSTEM_TEAMPROJECTID) ) @@ -72,7 +73,8 @@ function QueuePop([ref]$queue) { function GeneratePRMatrixForBatch { param ( - [Parameter(Mandatory = $true)][array] $Packages + [Parameter(Mandatory = $true)][array] $Packages, + [Parameter(Mandatory = $false)][bool] $FullSparseMatrix = $false ) $OverallResult = @() @@ -85,6 +87,8 @@ function GeneratePRMatrixForBatch { $directBatch = $Packages[0].IncludedForValidation -eq $false Write-Host "Generating matrix for $($directBatch ? 'direct' : 'indirect') packages" + $batchNamePrefix = $($directBatch ? 'b' : 'ib') + # The key here is that after we group the packages by the matrix config objects, we can use the first item's MatrixConfig # to generate the matrix for the group, no reason to have to parse the key value backwards to get the matrix config. $matrixBatchesByConfig = Group-ByObjectKey $Packages "CIMatrixConfigs" @@ -134,10 +138,10 @@ function GeneratePRMatrixForBatch { # we only need to modify the generated job name if there is more than one matrix config + batch $matrixSuffixNecessary = $matrixBatchesByConfig.Keys.Count -gt 1 - # if we are doing direct packages, we need to walk the batches and duplicate the matrix config for each batch, fully assigning + # if we are doing direct packages (or a full indirect matrix), we need to walk the batches and duplicate the matrix config for each batch, fully assigning # the each batch's packages to the matrix config. This will generate a _non-sparse_ matrix for the incoming packages - if ($directBatch) { - $batchSuffixNecessary = $packageBatches.Length -gt 1 + if ($directBatch -or $FullSparseMatrix) { + $batchSuffixNecessary = $packageBatches.Length -gt $($directBatch ? 1 : 0) $batchCounter = 1 foreach ($batch in $packageBatches) { @@ -155,7 +159,7 @@ function GeneratePRMatrixForBatch { } if ($batchSuffixNecessary) { - $outputItem["name"] = $outputItem["name"] + "_b$batchCounter" + $outputItem["name"] = $outputItem["name"] + "$batchNamePrefix$batchCounter" } $OverallResult += $outputItem @@ -180,7 +184,7 @@ function GeneratePRMatrixForBatch { } if ($batchSuffixNecessary) { - $outputItem["name"] = $outputItem["name"] + "_ib$batchCounter" + $outputItem["name"] = $outputItem["name"] + "_$batchNamePrefix$batchCounter" } # now we need to take an item from the front of the matrix results, clone it, and add it to the back of the matrix results # we will add the cloned version to OverallResult @@ -236,7 +240,7 @@ if ($indirectPackages) { foreach($artifact in $indirectPackages) { Write-Host "-> $($artifact.ArtifactName)" } - $OverallResult += GeneratePRMatrixForBatch -Packages $indirectPackages + $OverallResult += GeneratePRMatrixForBatch -Packages $indirectPackages -FullSparseMatrix (-not $SparseIndirect) } $serialized = SerializePipelineMatrix $OverallResult From 7a3f210cf6924c6139e2493f5fd0625919af1f32 Mon Sep 17 00:00:00 2001 From: Ismael Navarro-Fuentes <107213645+ismael-ms@users.noreply.github.com> Date: Tue, 28 Jan 2025 00:15:36 -0800 Subject: [PATCH 54/74] Fix Get Current Condition response schema to reflect live configuration (#32295) --- .../1.1/examples/GetCurrentConditions.json | 18 +++++++++--------- .../data-plane/Weather/stable/1.1/weather.json | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json b/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json index 5a25b2c1bd17..58e780b2f06c 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json +++ b/specification/maps/data-plane/Weather/stable/1.1/examples/GetCurrentConditions.json @@ -105,39 +105,39 @@ "unit": "mm", "unitType": 3 }, - "pastThreeHours": { + "past3Hours": { "value": 0.8, "unit": "mm", "unitType": 3 }, - "pastSixHours": { + "past6Hours": { "value": 0.8, "unit": "mm", "unitType": 3 }, - "pastNineHours": { + "past9Hours": { "value": 0.8, "unit": "mm", "unitType": 3 }, - "pastTwelveHours": { + "past12Hours": { "value": 0.8, "unit": "mm", "unitType": 3 }, - "pastEighteenHours": { + "past18Hours": { "value": 0.8, "unit": "mm", "unitType": 3 }, - "pastTwentyFourHours": { + "past24Hours": { "value": 0.8, "unit": "mm", "unitType": 3 } }, "temperatureSummary": { - "pastSixHours": { + "past6Hours": { "minimum": { "value": 8.3, "unit": "C", @@ -149,7 +149,7 @@ "unitType": 17 } }, - "pastTwelveHours": { + "past12Hours": { "minimum": { "value": 5.9, "unit": "C", @@ -161,7 +161,7 @@ "unitType": 17 } }, - "pastTwentyFourHours": { + "past24Hours": { "minimum": { "value": 5.9, "unit": "C", diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json index cea6c4b5c9e4..f7286f56d6c6 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/weather.json +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -2292,27 +2292,27 @@ "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past hour." }, - "pastThreeHours": { + "past3Hours": { "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past three hours." }, - "pastSixHours": { + "past6Hours": { "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values." }, - "pastNineHours": { + "past9Hours": { "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past nine hours." }, - "pastTwelveHours": { + "past12Hours": { "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours." }, - "pastEighteenHours": { + "past18Hours": { "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours." }, - "pastTwentyFourHours": { + "past24Hours": { "$ref": "#/definitions/WeatherUnit", "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours." } @@ -2335,15 +2335,15 @@ "TemperatureSummary": { "type": "object", "properties": { - "pastSixHours": { + "past6Hours": { "$ref": "#/definitions/PastHoursTemperature", "description": "Summary of temperature fluctuations over the past 6 hours." }, - "pastTwelveHours": { + "past12Hours": { "$ref": "#/definitions/PastHoursTemperature", "description": "Summary of temperature fluctuations over the past 12 hours." }, - "pastTwentyFourHours": { + "past24Hours": { "$ref": "#/definitions/PastHoursTemperature", "description": "Summary of temperature fluctuations over the past 24 hours." } From c540a6e88a351e3246977621e2ac88deef25f202 Mon Sep 17 00:00:00 2001 From: srilipta-swain <147700254+srilipta-swain@users.noreply.github.com> Date: Tue, 28 Jan 2025 19:59:15 +0530 Subject: [PATCH 55/74] Review request for Microsoft.Migrate/AssessmentProjects to add version preview/2024-01-01-preview (#31890) * Base commit * Added changes to json & updated examples --- ...smentOperations_Create_MaximumSet_Gen.json | 146 + ...smentOperations_Delete_MaximumSet_Gen.json | 15 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 25 + ...sessmentOperations_Get_MaximumSet_Gen.json | 65 + ...istByAssessmentProject_MaximumSet_Gen.json | 73 + ...sClusterOperations_Get_MaximumSet_Gen.json | 54 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 59 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 47 + ...sOptionsOperations_Get_MaximumSet_Gen.json | 38 + ...istByAssessmentProject_MaximumSet_Gen.json | 42 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 63 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 67 + ...MachinesOperations_Get_MaximumSet_Gen.json | 134 + ...tions_ListByAssessment_MaximumSet_Gen.json | 142 + ...tabaseV2Operations_Get_MaximumSet_Gen.json | 225 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 233 + ...stanceV2Operations_Get_MaximumSet_Gen.json | 474 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 505 + ...MachinesOperations_Get_MaximumSet_Gen.json | 155 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 163 + ...edEntityOperations_Get_MaximumSet_Gen.json | 330 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 330 + ...WebAppV2Operations_Get_MaximumSet_Gen.json | 63 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 71 + ...licationOperations_Get_MaximumSet_Gen.json | 73 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 81 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 3103 ++ ...istByAssessmentProject_MaximumSet_Gen.json | 3107 ++ ...tSummaryOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...jectsOperations_Create_MaximumSet_Gen.json | 144 + ...jectsOperations_Delete_MaximumSet_Gen.json | 14 + ...ProjectsOperations_Get_MaximumSet_Gen.json | 69 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...ons_ListBySubscription_MaximumSet_Gen.json | 72 + ...jectsOperations_Update_MaximumSet_Gen.json | 88 + ...mentsOperations_Create_MaximumSet_Gen.json | 249 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 109 + ...Operations_ListByGroup_MaximumSet_Gen.json | 113 + ...MachinesOperations_Get_MaximumSet_Gen.json | 81 + ...ns_ListByAvsAssessment_MaximumSet_Gen.json | 89 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 184 + ...istByAssessmentProject_MaximumSet_Gen.json | 188 + ...mentsOperations_Create_MaximumSet_Gen.json | 329 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 149 + ...Operations_ListByGroup_MaximumSet_Gen.json | 153 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 273 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 277 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 301 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 305 + ...rations_CompareSummary_MaximumSet_Gen.json | 263 + ...sCaseOperations_Create_MaximumSet_Gen.json | 383 + ...sCaseOperations_Delete_MaximumSet_Gen.json | 15 + ...s_GetReportDownloadUrl_MaximumSet_Gen.json | 25 + ...nessCaseOperations_Get_MaximumSet_Gen.json | 142 + ...istByAssessmentProject_MaximumSet_Gen.json | 146 + ...wSummaryOperations_Get_MaximumSet_Gen.json | 205 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 209 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 258 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 262 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...EntitiesOperations_Get_MaximumSet_Gen.json | 41 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 49 + ...dWebAppsOperations_Get_MaximumSet_Gen.json | 38 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 46 + ...roupsOperations_Create_MaximumSet_Gen.json | 85 + ...roupsOperations_Delete_MaximumSet_Gen.json | 15 + .../GroupsOperations_Get_MaximumSet_Gen.json | 44 + ...istByAssessmentProject_MaximumSet_Gen.json | 48 + ...rations_UpdateMachines_MaximumSet_Gen.json | 58 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 62 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 33 + ...istByAssessmentProject_MaximumSet_Gen.json | 37 + ...MachinesOperations_Get_MaximumSet_Gen.json | 89 + ...istByAssessmentProject_MaximumSet_Gen.json | 97 + .../Operations_List_MaximumSet_Gen.json | 28 + ...ctionOperations_Delete_MaximumSet_Gen.json | 15 + ...nnectionOperations_Get_MaximumSet_Gen.json | 39 + ...istByAssessmentProject_MaximumSet_Gen.json | 43 + ...ctionOperations_Update_MaximumSet_Gen.json | 76 + ...ResourceOperations_Get_MaximumSet_Gen.json | 37 + ...istByAssessmentProject_MaximumSet_Gen.json | 41 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 1635 + ...istByAssessmentProject_MaximumSet_Gen.json | 1639 + ...entV2Operations_Create_MaximumSet_Gen.json | 219 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 94 + ...Operations_ListByGroup_MaximumSet_Gen.json | 254 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 128 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 132 + ...ectorOperations_Create_MaximumSet_Gen.json | 97 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 56 + ...istByAssessmentProject_MaximumSet_Gen.json | 60 + ...entV2Operations_Create_MaximumSet_Gen.json | 167 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 70 + ...Operations_ListByGroup_MaximumSet_Gen.json | 74 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 61 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 65 + ...ectorOperations_Create_MaximumSet_Gen.json | 99 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...cePlanV2Operations_Get_MaximumSet_Gen.json | 52 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 60 + .../preview/2024-01-01-preview/migrate.json | 25091 ++++++++++++++++ .../AssessmentProjects/readme.md | 18 +- 132 files changed, 47438 insertions(+), 1 deletion(-) create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/migrate.json diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..81b6b7c84088 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "title": "AksAssessmentOperations_Create", + "operationId": "AksAssessmentOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "resource": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd71728a9458 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "AksAssessmentOperations_Delete", + "operationId": "AksAssessmentOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..61c01e501274 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "AksAssessmentOperations_DownloadUrl", + "operationId": "AksAssessmentOperations_DownloadUrl", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "vthjjfdenyh", + "expirationTime": "2023-11-07T06:51:25.205Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d422f3a705e0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "AksAssessmentOperations_Get", + "operationId": "AksAssessmentOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..e291075104e9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AksAssessmentOperations_ListByAssessmentProject", + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "polt", + "$top": 5, + "$filter": "azekdtdhupdngbqxzdppicwf", + "totalRecordCount": 18, + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cff5752010dc --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "AksClusterOperations_Get", + "operationId": "AksClusterOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "clusterName": "testaksassessment-cluster" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..f001473c12a3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "AksClusterOperations_ListByAksAssessment", + "operationId": "AksClusterOperations_ListByAksAssessment", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "sfmesuqkmjezolfjvalm", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..66083fdcfe30 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "AksCostDetailOperations_ListByAksAssessment", + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "ww", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 16, + "podCount": 7, + "monthlyCost": 6, + "podApproxMonthlyCost": 27 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/costDetails/testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "type": "AKSAssessmentCostDetail", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3713855afd7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "AksOptionsOperations_Get", + "operationId": "AksOptionsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8e273d30d73 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "AksOptionsOperations_ListByAssessmentProject", + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..304ed14425de --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AksSummaryOperations_Get", + "operationId": "AksSummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "summaryName": "AKS" + }, + "responses": { + "200": { + "body": { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..720229c95917 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "AksSummaryOperations_ListByAksAssessment", + "operationId": "AksSummaryOperations_ListByAksAssessment", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..dec903152611 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,134 @@ +{ + "title": "AssessedMachinesOperations_Get", + "operationId": "AssessedMachinesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "projectName": "pavqtntysjn", + "groupName": "smawqdmhfngray", + "assessmentName": "qjlumxyqsitd", + "assessedMachineName": "oqxjeheiipjmuo" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "PremiumV2", + "recommendedDiskType": "PremiumV2", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 125, + "recommendedDiskIops": 3000, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": 25.141248, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..cfe93dce0da6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json @@ -0,0 +1,142 @@ +{ + "title": "AssessedMachinesOperations_ListByAssessment", + "operationId": "AssessedMachinesOperations_ListByAssessment", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "$filter": "sbkdovsfqldhdb", + "pageSize": 10, + "continuationToken": "hbyseetshbplfkjmpjhsiurqgt", + "totalRecordCount": 25, + "projectName": "sloqixzfjk", + "groupName": "kjuepxerwseq", + "assessmentName": "rhzcmubwrrkhtocsibu" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "PremiumV2", + "recommendedDiskType": "PremiumV2", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 125, + "recommendedDiskIops": 3000, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": 25.141248, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..49ec4005414b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,225 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_Get", + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlDatabaseName": "858eb860-9e07-417c-91b6-bca1bffb3bf5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..245e3d0ab3dd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,233 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DatabaseName,'adv130'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd298023f46d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,474 @@ +{ + "title": "AssessedSqlInstanceV2Operations_Get", + "operationId": "AssessedSqlInstanceV2Operations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlInstanceName": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "name": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "logDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 32.94432, + "monthlyStorageCost": 3.12, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigratePrimaryReplicaAndAllOtherReplicasToIaaS", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "2 PremiumSSD(P2)" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "memoryInUseInMB": 4096.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "BusinessCritical", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 32768.0, + "predictedDataSizeInMB": 112.0, + "predictedLogSizeInMB": 112.0, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 475.999296, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "InstanceCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsAlwaysOnInstanceReplicaRequirementWithoutSecondaries", + "reasoningString": null, + "reasoningCategory": "AlwaysOnAG", + "contextParameters": [ + { + "contextKey": "AlwaysOnDatabaseServiceTier", + "contextValue": "BusinessCritical" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "BusinessCritical" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 833.165424, + "monthlyStorageCost": 24.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": { + "numberOfSynchronousReadReplicas": 0, + "numberOfSynchronousNonReadReplicas": 0, + "numberOfAsynchronousReadReplicas": 0, + "numberOfAsynchronousNonReadReplicas": 0, + "numberOfPrimaryReplicas": 6 + }, + "isClustered": false, + "isHighAvailabilityEnabled": true, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedWithWarningsForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "1" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + } + ], + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/184b8433-6991-45db-9f57-3dd3f6397a60", + "machineName": "SQLAGVM02", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/13c17b85-8842-4d50-a640-df0e45e56670", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 2, + "percentageCoresUtilization": 100.0, + "logicalDisks": [ + { + "diskId": "s:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "l:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "c:", + "diskSizeInMB": 16.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 6, + "totalDatabaseSizeInMB": 224.0, + "largestDatabaseSizeInMB": 144.0, + "totalDiscoveredUserDatabases": 7 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.9353438Z", + "updatedTimestamp": "2023-09-08T05:22:35.9666076Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..f5ae7f4b6cee --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,505 @@ +{ + "title": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/groups/test_paas_pref_grp_2812/sqlAssessments/test_train_250823/assessedSqlInstances/27b94796-026e-4278-a546-664d46977c0a", + "name": "27b94796-026e-4278-a546-664d46977c0a", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.2 + } + ], + "logDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P3", + "diskRedundancy": "LRS", + "storageCost": 2.4 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 26.361408, + "monthlyStorageCost": 3.6, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsVirtualMachineCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "0" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOPSRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineUncachedDiskIOPSAvailableInIOPerSec", + "contextValue": "3200" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOThroughputRequiredInInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineIOThroughputUncachedAvailableInIOPerSec", + "contextValue": "48" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "1 PremiumSSD_P2,1 PremiumSSD_P3" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "memoryInUseInMB": 0.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 65536.0, + "predictedDataSizeInMB": 6696.25, + "predictedLogSizeInMB": 14220.125, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 199.999104, + "monthlyStorageCost": 3.68, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToMI", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsInstanceCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "6.539" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "13.887" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "64" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "2048" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "InstanceLevelThroughputRequiredInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelThroughputAvailableInMBPerSec", + "contextValue": "10" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOPSDataLogRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "InstanceLevelIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelIOPSAvailableInIOPerSec", + "contextValue": "6000" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 1199.994624, + "monthlyStorageCost": 7.13, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToDB", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "ServerCredentials", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "accessibilitytestdiag917", + "objectType": "ServerCredential" + } + ] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 6696.25, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 14220.125, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": null, + "isClustered": false, + "isHighAvailabilityEnabled": false, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "0" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "SQLMICost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLMICost", + "contextValue": "203.679104" + } + ] + }, + { + "reasoningId": "SQLDBCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLDBCost", + "contextValue": "1207.124624" + } + ] + } + ], + "sizingCriterion": "PerformanceBased", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/machines/daf51245-560b-4caa-9c18-5409ab93d319", + "machineName": "SQLTestDBVM46", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/dhlodhiccy/providers/microsoft.offazure/mastersites/dhccy37819mastersite/sqlsites/dhccy37819sqlsites/sqlservers/a5a6441d-9f63-463e-a720-73fecd90a2e4", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 4, + "percentageCoresUtilization": 0.0, + "logicalDisks": [ + { + "diskId": "d:", + "diskSizeInMB": 20916.375, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 12, + "totalDatabaseSizeInMB": 20916.375, + "largestDatabaseSizeInMB": 20815.0, + "totalDiscoveredUserDatabases": 12 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-08-25T09:20:24.5544874Z", + "updatedTimestamp": "2023-08-25T09:20:25.2195402Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..74916b76226e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "AssessedSqlMachinesOperations_Get", + "operationId": "AssessedSqlMachinesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlMachineName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..cfa9385aa652 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,163 @@ +{ + "title": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DisplayName,'SQLHAVM17'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines?api-version=2024-01-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvANYGbAopzgkAAAAAAg%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65551%23QCF%3a8%23FPC%3aASnOCQAAAAACO84JAAAAAAI%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D9CD673390%22%2c%22max%22%3a%2205C1DFFFFFFFF4%22%7d%7d%5d&totalRecordCount=19" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0f06019c0e17 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_Get", + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "recommendedAssessedEntityName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..66079f500e60 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities?api-version=2024-01-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvAMMvEvMxeAsAAAAABQ%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65567%23QCF%3a8%23FPC%3aATF4CwAAAAAFRXgLAAAAAAU%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D32F43775C%22%2c%22max%22%3a%2205C1DFFFFFFFFC%22%7d%7d%5d&totalRecordCount=21" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..12a7cc107b01 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AssessedWebAppV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "assessedWebAppName": "webapp1" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-001-azureappservice", + "suitability": "Suitable", + "securitySuitability": "Unknown", + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1" + }, + "migrationIssues": [ + { + "issueId": "AppPoolIdentityCheck", + "issueCategory": "Info", + "issueDescriptionList": [ + "SpecificUser (SharePoint - 80), SpecificUser (SecurityTokenServiceApplicationPool)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice,plan-001-azureappservicecontainer", + "machineName": "a404-r1w28r2-1", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "100%WebSite", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/aa096c1b26cd80dd76e547d61d722d04e1779a9c8d95ae1baa91bdb226eb5c3d-9e55bf838a799e058f7c0478ff1029d5224456ab0a1c30f3a8779ba7bb841e88", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5037cd30-828f-f362-c62c-d1715b8ede4c", + "confidenceRatingInPercentage": null, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/assessedWebApps/e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "name": "e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..3601cbfcb793 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "", + "pageSize": 23, + "continuationToken": "pwqummugahjguraaqqssuwmxic", + "totalRecordCount": 6, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "akgugrp2", + "assessmentName": "assess1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-003-azureappservicecontainer", + "suitability": "ConditionallySuitable", + "securitySuitability": "Suitable", + "webAppSkuName": "Premium_V3", + "webAppSkuSize": "P1 v3" + }, + "migrationIssues": [ + { + "issueId": "AuthCheckContainer", + "issueCategory": "Info", + "issueDescriptionList": [ + "windowsAuthentication (/)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice", + "machineName": "windows-2k16", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "Microsoft Azure Migrate App Containerization", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/70c2efd9345164750ddf889a474512530466d8f7aaa85052b59a73ff6a4d41b1-ae625d98de8e57d253ae9812590de37f17f382bcd47da01c2f3f9be5350ae98e", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5015ed4a-5f13-8cd3-a4d4-1ec729e836ff", + "confidenceRatingInPercentage": 11, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/akgugrp2/webAppAssessments/akgutestappsvc2/assessedWebApps/2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "name": "2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a85447d30695 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessedWebApplicationOperations_Get", + "operationId": "AssessedWebApplicationOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "assessedWorkload": "testaksassessmentapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..e0c60382a52c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AssessedWebApplicationOperations_ListByAksAssessment", + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "gjilveslqiowaembajtj", + "$top": 13, + "$filter": "zqvpvrpvghjnxamq", + "totalRecordCount": 23, + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8d660357672 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,3103 @@ +{ + "title": "AssessmentOptionsOperations_Get", + "operationId": "AssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "premiumV2DiskSupportedLocations": [ + "CentralUs", + "SouthAfricaNorth", + "NorthEurope", + "FranceCentral", + "SwedenCentral", + "PolandCentral", + "JapanEast", + "SwitzerlandNorth", + "AustraliaEast", + "SouthCentralUs", + "GermanyWestCentral", + "UAENorth", + "WestEurope", + "WestUs2", + "CentralIndia", + "SoutheastAsia", + "BrazilSouth", + "KoreaCentral", + "EastUs2", + "EastUs", + "CanadaCentral", + "UkSouth" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..5446a43817bd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,3107 @@ +{ + "title": "AssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "fhodvffhuoqwbysrrqbizete" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "premiumV2DiskSupportedLocations": [ + "CentralUs", + "SouthAfricaNorth", + "NorthEurope", + "FranceCentral", + "SwedenCentral", + "PolandCentral", + "JapanEast", + "SwitzerlandNorth", + "AustraliaEast", + "SouthCentralUs", + "GermanyWestCentral", + "UAENorth", + "WestEurope", + "WestUs2", + "CentralIndia", + "SoutheastAsia", + "BrazilSouth", + "KoreaCentral", + "EastUs2", + "EastUs", + "CanadaCentral", + "UkSouth" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1bb9984f4ff8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "AssessmentProjectSummaryOperations_Get", + "operationId": "AssessmentProjectSummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project", + "projectSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..fe6062893843 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdef" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..771ed9ad3c4e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "title": "AssessmentProjectsOperations_Create", + "operationId": "AssessmentProjectsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "resource": { + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..465aeac6f7c1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "AssessmentProjectsOperations_Delete", + "operationId": "AssessmentProjectsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "zqrsyncwahgydqvwuchkfd" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..c886117acc79 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "AssessmentProjectsOperations_Get", + "operationId": "AssessmentProjectsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..311d4cac2161 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessmentProjectsOperations_ListByResourceGroup", + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects?api-version=2024-01-01-preview&%24skiptoken=1ZFNboMwEIXv4nWMCT9pihRVKGIXqirAASZ44joIG82YtGqUu9c9Rndv8Unfe3oP4fA7nKybWFQPcWze%2b3N9GrpmqD9EJT5DWLhSagYHBmd0IYGflTAZ%2fax4vfBIdgnWO1bFRWcA6VVmMchC717k6xb2soSizHNd7ndpqgjZrzSiIb8urBgmcF9AaiF%2ftxqJVWtH8uyvIWmtIQiogBmZ%2f9yRuuEY%2bA0WK%2b%2bRjuJDlma5THO5LcVGNHXXD132L9s%2fNwJoro0hNHG37v2ELn5Qn1vx%2fAU%3d" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..18ae9ef00d59 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "AssessmentProjectsOperations_ListBySubscription", + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdefg" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..e5cc4700c246 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,88 @@ +{ + "title": "AssessmentProjectsOperations_Update", + "operationId": "AssessmentProjectsOperations_Update", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "properties": { + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e486ad8d089e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,249 @@ +{ + "title": "AssessmentsOperations_Create", + "operationId": "AssessmentsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "resource": { + "properties": { + "eaSubscriptionId": "kwsu", + "azurePricingTier": "Standard", + "azureStorageRedundancy": "Unknown", + "reservedInstance": "None", + "azureHybridUseBenefit": "Unknown", + "linuxAzureHybridUseBenefit": "Unknown", + "azureDiskTypes": [ + "Premium", + "PremiumV2", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 26 + }, + "groupType": "Default", + "assessmentType": "Unknown", + "azureLocation": "njxbwdtsxzhichsnk", + "azureOfferCode": "Unknown", + "currency": "Unknown", + "scalingFactor": 24, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": 25.141248, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "PremiumV2", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": 25.141248, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "PremiumV2", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..57a19914f4f8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AssessmentsOperations_Delete", + "operationId": "AssessmentsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..66d88d83dedd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "uri/uri/uri", + "expirationTime": "2023-09-26T09:36:57.114Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0e07a6b0a2ca --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,109 @@ +{ + "title": "AssessmentsOperations_Get", + "operationId": "AssessmentsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": 25.141248, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "PremiumV2", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..4d7e3909f952 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,113 @@ +{ + "title": "AssessmentsOperations_ListByGroup", + "operationId": "AssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": 25.141248, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "PremiumV2", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..38223230b9bd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AvsAssessedMachinesOperations_Get", + "operationId": "AvsAssessedMachinesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "avsAssessedMachineName": "b6d6fc6f-796f-4c16-96af-a6d22e0f12f7" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..ebade44315c9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "$filter": "ujmwhhuloficljxcjyc", + "pageSize": 6, + "continuationToken": "qwrjeiukbcicfrkqlqsfukfc", + "totalRecordCount": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..dfc357835ae5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "AvsAssessmentOptionsOperations_Get", + "operationId": "AvsAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "avsAssessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..191daf819cf6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,188 @@ +{ + "title": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..826a285202be --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,329 @@ +{ + "title": "AvsAssessmentsOperations_Create", + "operationId": "AvsAssessmentsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "resource": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P", + "AV64" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "reservedInstance": "RI3Year", + "suitability": "Unknown", + "suitabilityExplanation": "Unknown", + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "cpuHeadroom": 12, + "isStretchClusterEnabled": true, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "cpuHeadroom": 12, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyExternalStorageCost", + "value": 600.0, + "description": "Monthly External Storage Cost for Assessment." + }, + { + "name": "MonthlyNetworkCost", + "value": 120, + "description": "Monthly Cost of Network." + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "cpuHeadroom": 12, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..703f25e3085c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AvsAssessmentsOperations_Delete", + "operationId": "AvsAssessmentsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..d7e45b6cc554 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..c091f28bb6e1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,149 @@ +{ + "title": "AvsAssessmentsOperations_Get", + "operationId": "AvsAssessmentsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "cpuHeadroom": 12, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..a5fcd8ea65a4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,153 @@ +{ + "title": "AvsAssessmentsOperations_ListByGroup", + "operationId": "AvsAssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "cpuHeadroom": 12, + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..08570cce83ad --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,273 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_Get", + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "avsSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..6351918f8f28 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,277 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..565e11ddc714 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,301 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_Get", + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "iaasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..c448e9a204b8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,305 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..d5a17d65021a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json @@ -0,0 +1,263 @@ +{ + "title": "Get Compare summary report for Business case.", + "operationId": "BusinessCaseOperations_CompareSummary", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "azurePaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "azureAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesPaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesPaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesIaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesAvsDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "linuxAhubSavings": 10, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "futureCostDetails": { + "storageCost": 28, + "computeCost": 14, + "itLaborCost": 12, + "networkCost": 8, + "ahubSavings": 21, + "linuxAhubSavings": 10, + "securityCost": 19, + "managementCostDetails": { + "managementCost": 24, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 28 + } + ] + }, + "esuSavings": 22, + "facilitiesCost": 19 + }, + "azureArcEnabledOnPremisesCostDetails": { + "storageCost": 28, + "computeCost": 14, + "itLaborCost": 12, + "networkCost": 8, + "ahubSavings": 21, + "linuxAhubSavings": 10, + "securityCost": 19, + "managementCostDetails": { + "managementCost": 24, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 28 + } + ] + }, + "esuSavings": 22, + "facilitiesCost": 19 + }, + "futureAzureArcEnabledOnPremisesCostDetails": { + "storageCost": 28, + "computeCost": 14, + "itLaborCost": 12, + "networkCost": 8, + "ahubSavings": 21, + "linuxAhubSavings": 10, + "securityCost": 19, + "managementCostDetails": { + "managementCost": 24, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 28 + } + ] + }, + "esuSavings": 22, + "facilitiesCost": 19 + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..070b430d7240 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,383 @@ +{ + "title": "BusinessCaseOperations_Create", + "operationId": "BusinessCaseOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "resource": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "vMwareCloudFoundationLicenseCost": 7 + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCostPerKwh": 28 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + }, + "azureArcSettings": { + "azureArcState": "Enabled", + "laborCostPercentage": 70, + "managementSettings": { + "monitoringSettings": { + "logsVolumeInGB": 0.5, + "alertRulesCount": 10 + } + } + } + }, + "state": "InProgress" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "vMwareCloudFoundationLicenseCost": 7 + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCostPerKwh": 28 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + }, + "azureArcSettings": { + "azureArcState": "Enabled", + "laborCostPercentage": 70, + "managementSettings": { + "monitoringSettings": { + "logsVolumeInGB": 0.5, + "alertRulesCount": 10 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "vMwareCloudFoundationLicenseCost": 7 + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCostPerKwh": 28 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + }, + "azureArcSettings": { + "azureArcState": "Enabled", + "laborCostPercentage": 70, + "managementSettings": { + "monitoringSettings": { + "logsVolumeInGB": 0.5, + "alertRulesCount": 10 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..081623cb5e3e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "BusinessCaseOperations_Delete", + "operationId": "BusinessCaseOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..b546952d6e98 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "Get download URL for the business case report.", + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "businessCaseReportUrl": "mxwaejake", + "expirationTime": "2023-11-08T07:10:20.491Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca78672b5f3c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,142 @@ +{ + "title": "BusinessCaseOperations_Get", + "operationId": "BusinessCaseOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "vMwareCloudFoundationLicenseCost": 7 + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCostPerKwh": 28 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + }, + "azureArcSettings": { + "azureArcState": "Enabled", + "laborCostPercentage": 70, + "managementSettings": { + "monitoringSettings": { + "logsVolumeInGB": 0.5, + "alertRulesCount": 10 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2024-01-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae98305dbb2e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "title": "BusinessCaseOperations_ListByAssessmentProject", + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "vMwareCloudFoundationLicenseCost": 7 + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCostPerKwh": 28 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + }, + "azureArcSettings": { + "azureArcState": "Enabled", + "laborCostPercentage": 70, + "managementSettings": { + "monitoringSettings": { + "logsVolumeInGB": 0.5, + "alertRulesCount": 10 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2024-01-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/businessCase1", + "name": "businessCase1", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..54efcd64d477 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,205 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_Get", + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "overviewSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0, + "azureArcEnabledOnPremisesCost": [ + { + "year": "Year0", + "cost": 8646893.36496789 + }, + { + "year": "Year1", + "cost": 6452444.63321628 + }, + { + "year": "Year2", + "cost": 7361476.3148771 + }, + { + "year": "Year3", + "cost": 7893482.58062095 + } + ], + "futureCost": [ + { + "year": "Year0", + "cost": 8619047.96496789 + }, + { + "year": "Year1", + "cost": 5847511.33627395 + }, + { + "year": "Year2", + "cost": 5363132.85669087 + }, + { + "year": "Year3", + "cost": 3616793.89850464 + } + ], + "futureAzureArcEnabledOnPremisesEsuCost": [ + { + "year": "Year0", + "cost": 2777682.6 + }, + { + "year": "Year1", + "cost": 217405.65 + }, + { + "year": "Year2", + "cost": 334683.25 + }, + { + "year": "Year3", + "cost": 0 + } + ], + "futureOnPremisesEsuCost": [ + { + "year": "Year0", + "cost": 3742242.49 + }, + { + "year": "Year1", + "cost": 413811.16 + }, + { + "year": "Year2", + "cost": 250961.91 + }, + { + "year": "Year3", + "cost": 0 + } + ] + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + }, + "azureArcEnabledOnPremisesCost": 6, + "futureCostIncludingAzureArc": 27, + "futureEsuSavingsFor4YearsIncludingAzureArc": 7, + "futureManagementCostSavingsIncludingAzureArc": 24, + "futureSecurityCostSavingsIncludingAzureArc": 18, + "azureArcServicesCost": 27, + "futureAzureIaasCost": 23, + "futureAzurePaasCost": 28, + "futureAzureArcEnabledOnPremisesCost": 13, + "futureAzureArcServicesCost": 7 + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..8795511337ba --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,209 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0, + "azureArcEnabledOnPremisesCost": [ + { + "year": "Year0", + "cost": 8646893.36496789 + }, + { + "year": "Year1", + "cost": 6452444.63321628 + }, + { + "year": "Year2", + "cost": 7361476.3148771 + }, + { + "year": "Year3", + "cost": 7893482.58062095 + } + ], + "futureCost": [ + { + "year": "Year0", + "cost": 8619047.96496789 + }, + { + "year": "Year1", + "cost": 5847511.33627395 + }, + { + "year": "Year2", + "cost": 5363132.85669087 + }, + { + "year": "Year3", + "cost": 3616793.89850464 + } + ], + "futureAzureArcEnabledOnPremisesEsuCost": [ + { + "year": "Year0", + "cost": 2777682.6 + }, + { + "year": "Year1", + "cost": 217405.65 + }, + { + "year": "Year2", + "cost": 334683.25 + }, + { + "year": "Year3", + "cost": 0 + } + ], + "futureOnPremisesEsuCost": [ + { + "year": "Year0", + "cost": 3742242.49 + }, + { + "year": "Year1", + "cost": 413811.16 + }, + { + "year": "Year2", + "cost": 250961.91 + }, + { + "year": "Year3", + "cost": 0 + } + ] + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + }, + "azureArcEnabledOnPremisesCost": 6, + "futureCostIncludingAzureArc": 27, + "futureEsuSavingsFor4YearsIncludingAzureArc": 7, + "futureManagementCostSavingsIncludingAzureArc": 24, + "futureSecurityCostSavingsIncludingAzureArc": 18, + "azureArcServicesCost": 27, + "futureAzureIaasCost": 23, + "futureAzurePaasCost": 28, + "futureAzureArcEnabledOnPremisesCost": 13, + "futureAzureArcServicesCost": 7 + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f27a1552c0f0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,258 @@ +{ + "title": "BusinessCasePaasSummaryOperations_Get", + "operationId": "BusinessCasePaasSummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "paasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..460f6548e4f6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,262 @@ +{ + "title": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28, + "facilitiesCost": 19 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..93431fde5af0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedAvsMachinesOperations_Get", + "operationId": "EvaluatedAvsMachinesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedAvsMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..39bae42ef362 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "zcwvgkjkvddoylnfkgclpytp", + "pageSize": 9, + "continuationToken": "er", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8574981bce92 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedMachinesOperations_Get", + "operationId": "EvaluatedMachinesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..a14b3f17ef36 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "fyiccra", + "pageSize": 16, + "continuationToken": "mipqzxorbubmdjm", + "totalRecordCount": 28, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..600b26f45a52 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_Get", + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedSqlEntityName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..029c4710ff8a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "rukrirndrwnypcf", + "pageSize": 13, + "continuationToken": "bqkhzxsvqhnarrffqtgeytrznivh", + "totalRecordCount": 12, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2fbc37fec58e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "EvaluatedWebAppsOperations_Get", + "operationId": "EvaluatedWebAppsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedWebAppName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0a3552b130f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EvaluatedWebAppsOperations_ListByBusinessCase", + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "pwrvmthelxikwweggf", + "pageSize": 18, + "continuationToken": "oizcutotskmhqxxmpwiqzvzyaubjt", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6b13a21a2401 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "GroupsOperations_Create", + "operationId": "GroupsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "resource": { + "properties": { + "groupStatus": "Completed", + "groupType": "Default", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e30dbe7962d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "GroupsOperations_Delete", + "operationId": "GroupsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..80bdcea26e68 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GroupsOperations_Get", + "operationId": "GroupsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..057688ddde38 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "GroupsOperations_ListByAssessmentProject", + "operationId": "GroupsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..d2b159a682b5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Update machines in group.", + "operationId": "GroupsOperations_UpdateMachines", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "body": { + "eTag": "*", + "properties": { + "operationType": "Add", + "machines": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/18895660-c5e5-4247-8cfc-cd24e1fe57f3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..62f09d3a713e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "HypervCollectorsOperations_Create", + "operationId": "HypervCollectorsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..591f324ee513 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "HypervCollectorsOperations_Delete", + "operationId": "HypervCollectorsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0246f4268904 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "HypervCollectorsOperations_Get", + "operationId": "HypervCollectorsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..f95063d4a4a9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "HypervCollectorsOperations_ListByAssessmentProject", + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..355585e17dc1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "title": "ImportCollectorsOperations_Create", + "operationId": "ImportCollectorsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5", + "resource": { + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c912636fd983 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ImportCollectorsOperations_Delete", + "operationId": "ImportCollectorsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d8332a730380 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ImportCollectorsOperations_Get", + "operationId": "ImportCollectorsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..87c048d9c3c7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ImportCollectorsOperations_ListByAssessmentProject", + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ad6f0a598550 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "MachinesOperations_Get", + "operationId": "MachinesOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "machineName": "55082b89-99e2-4c40-b63f-d4f4d6ba961d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d1252580e14 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "MachinesOperations_ListByAssessmentProject", + "operationId": "MachinesOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "$filter": null, + "pageSize": 1, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..3e8c063eee98 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AksAssessmentOperations_Get", + "isDataAction": true, + "display": { + "provider": "Microsoft.Migrate", + "resource": "AKSAssessment", + "operation": "GET", + "description": "AKSAssessment" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c138d9e70d4d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnectionOperations_Delete", + "operationId": "PrivateEndpointConnectionOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..201a21745fdb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "PrivateEndpointConnectionOperations_Get", + "operationId": "PrivateEndpointConnectionOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..238780ebf854 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/avol" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3221323dca5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "PrivateEndpointConnectionOperations_Update", + "operationId": "PrivateEndpointConnectionOperations_Update", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ea6205f02cd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResourceOperations_Get", + "operationId": "PrivateLinkResourceOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateLinkResourceName": "Default" + }, + "responses": { + "200": { + "body": { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..9b264759fe14 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResourceOperations_ListByAssessmentProject", + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcd" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e02835d0e059 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "ServerCollectorsOperations_Create", + "operationId": "ServerCollectorsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector", + "resource": { + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..80c3087a4b5d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ServerCollectorsOperations_Delete", + "operationId": "ServerCollectorsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c7d073daf03 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "ServerCollectorsOperations_Get", + "operationId": "ServerCollectorsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..5f606e72c131 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "ServerCollectorsOperations_ListByAssessmentProject", + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..44a851cd3491 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,1635 @@ +{ + "title": "SqlAssessmentOptionsOperations_Get", + "operationId": "SqlAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..455d96820979 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,1639 @@ +{ + "title": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..5e8f6a709ff0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,219 @@ +{ + "title": "SqlAssessmentV2Operations_Create", + "operationId": "SqlAssessmentV2Operations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "resource": { + "properties": { + "entityUptime": { + "daysPerMonth": 30, + "hoursPerDay": 24 + }, + "osLicense": "Unknown", + "optimizationLogic": "MinimizeCost", + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Automatic", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Eadsv5_series" + ] + }, + "environmentType": "Production", + "reservedInstance": "None", + "reservedInstanceForVm": "None", + "sqlServerLicense": "Unknown", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "azureOfferCodeForVm": "MSAZR0003P", + "currency": "USD", + "percentile": "Percentile95", + "scalingFactor": 1, + "timeRange": "Day", + "discountPercentage": 0, + "sizingCriterion": "PerformanceBased", + "multiSubnetIntent": "DisasterRecovery", + "asyncCommitModeIntent": "DisasterRecovery", + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7cb4e3b7a16c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SqlAssessmentV2Operations_Delete", + "operationId": "SqlAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..c2256cb9864d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b1fee826ae7c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "SqlAssessmentV2Operations_Get", + "operationId": "SqlAssessmentV2Operations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..fb9c3146cef1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,254 @@ +{ + "title": "SqlAssessmentV2Operations_ListByGroup", + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_1", + "name": "test_assmt_hadr_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-02-16T16:14:03.477007Z", + "perfDataEndTime": "2023-02-17T16:14:03.477007Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2022-12-20T00:00:00Z", + "createdTimestamp": "2023-01-04T14:17:43.1744405Z", + "updatedTimestamp": "2023-02-17T16:16:25.1524275Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_2", + "name": "test_assmt_hadr_2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-06T07:47:29.6769501Z", + "perfDataEndTime": "2023-09-07T07:47:29.6769501Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-07T07:47:29.6925964Z", + "updatedTimestamp": "2023-09-07T07:49:26.5732595Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..41ba76871b52 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_Get", + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..ec7acbb99e66 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,132 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..b23e832569ce --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "SqlCollectorOperations_Create", + "operationId": "SqlCollectorOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d13a89202087 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "SqlCollectorOperations_Delete", + "operationId": "SqlCollectorOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f447c53252f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SqlCollectorOperations_Get", + "operationId": "SqlCollectorOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..cce2ff11bfa4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SqlCollectorOperations_ListByAssessmentProject", + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlcollectors/fci-ankit-test0c1esqlsitecollector", + "name": "fci-ankit-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..f521a8449706 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "VmwareCollectorsOperations_Create", + "operationId": "VmwareCollectorsOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector", + "resource": { + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d11da252af7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmwareCollectorsOperations_Delete", + "operationId": "VmwareCollectorsOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b56d505033c8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VmwareCollectorsOperations_Get", + "operationId": "VmwareCollectorsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..db43a8d064f8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "VmwareCollectorsOperations_ListByAssessmentProject", + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a71bf070f9c2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "WebAppAssessmentOptionsOperations_Get", + "operationId": "WebAppAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "WestEurope" + ] + } + ], + "savingsPlanSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..e549c89ecf48 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "92EA264C-A8A7-4192-A5E5-D9B487409240", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "PolandCentral" + ] + } + ], + "savingsPlanSupportedLocations": [ + "Unknown" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaSoutheast" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-06T05:40:17.507Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-06T05:40:17.507Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..b336923c5618 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,167 @@ +{ + "title": "WebAppAssessmentV2Operations_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "resource": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "status": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a4972ca42da7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..f6c0710bf2c7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "https://assessmentsrvcanccysa2.blob.core.windows.net/cc1325ff-d42f-4c45-bfb6-12069e45becb/anraghun-selfhost-v2anraghun-v2-testWebAppAssessment.xlsx?sv=2018-03-28&sr=b&sig=NYBG6gJmofvIQsk1K1tewWfX51BpFZWsvIy7gBXNYUE%3D&st=2023-11-03T05%3A51%3A39Z&se=2023-11-03T06%3A26%3A39Z&sp=r", + "expirationTime": "2023-11-03T05:42:09.465Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..5dc5d5e8d17a --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "WebAppAssessmentV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-v2-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "Unknown", + "currency": "MSAZR0003P", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..20d7fc9188b5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c0832d58ec3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "suitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 21, + "monthlySecurityCost": 3, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 4 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..6e0fad53021f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "conditionallySuitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 584, + "monthlySecurityCost": 0, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 2 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/anxenhw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae7055a01a84 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "WebAppCollectorOperations_Create", + "operationId": "WebAppCollectorOperations_Create", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1", + "resource": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..32745ddca4c3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "WebAppCollectorOperations_Delete", + "operationId": "WebAppCollectorOperations_Delete", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..702281678ab6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "WebAppCollectorOperations_Get", + "operationId": "WebAppCollectorOperations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..6dcd9eef975e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "WebAppCollectorOperations_ListByAssessmentProject", + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "agentProperties": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..36a1575d3bb2 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "WebAppServicePlanV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_Get", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "webAppServicePlanName": "plan-001" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..fd97c5edbd18 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2024-01-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "okepiszphg", + "pageSize": 18, + "$skipToken": "hcpyxryhoumfkypulwpsxxkzuu", + "totalRecordCount": 14, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/migrate.json new file mode 100644 index 000000000000..64bfb13600f1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2024-01-01-preview/migrate.json @@ -0,0 +1,25091 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Assessment Service", + "version": "2024-01-01-preview", + "description": "Azure Migrate Resource Provider management API." + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AssessmentProjectsOperations" + }, + { + "name": "AssessmentProjectSummaryOperations" + }, + { + "name": "MachinesOperations" + }, + { + "name": "GroupsOperations" + }, + { + "name": "AssessmentsOperations" + }, + { + "name": "AssessmentOptionsOperations" + }, + { + "name": "AssessedMachinesOperations" + }, + { + "name": "HypervCollectorsOperations" + }, + { + "name": "VmwareCollectorsOperations" + }, + { + "name": "ServerCollectorsOperations" + }, + { + "name": "ImportCollectorsOperations" + }, + { + "name": "PrivateEndpointConnectionOperations" + }, + { + "name": "PrivateLinkResourceOperations" + }, + { + "name": "AvsAssessmentsOperations" + }, + { + "name": "AvsAssessmentOptionsOperations" + }, + { + "name": "AvsAssessedMachinesOperations" + }, + { + "name": "SqlAssessmentV2SummaryOperations" + }, + { + "name": "SqlAssessmentV2Operations" + }, + { + "name": "SqlAssessmentOptionsOperations" + }, + { + "name": "AssessedSqlMachinesOperations" + }, + { + "name": "AssessedSqlRecommendedEntityOperations" + }, + { + "name": "AssessedSqlInstanceV2Operations" + }, + { + "name": "AssessedSqlDatabaseV2Operations" + }, + { + "name": "SqlCollectorOperations" + }, + { + "name": "WebAppAssessmentV2SummaryOperations" + }, + { + "name": "WebAppAssessmentV2Operations" + }, + { + "name": "WebAppAssessmentOptionsOperations" + }, + { + "name": "AssessedWebAppV2Operations" + }, + { + "name": "WebAppServicePlanV2Operations" + }, + { + "name": "WebAppCollectorOperations" + }, + { + "name": "BusinessCaseOperations" + }, + { + "name": "BusinessCaseIaasSummaryOperations" + }, + { + "name": "BusinessCasePaasSummaryOperations" + }, + { + "name": "BusinessCaseOverviewSummaryOperations" + }, + { + "name": "BusinessCaseAvsSummaryOperations" + }, + { + "name": "EvaluatedMachinesOperations" + }, + { + "name": "EvaluatedSqlEntitiesOperations" + }, + { + "name": "EvaluatedWebAppsOperations" + }, + { + "name": "EvaluatedAvsMachinesOperations" + }, + { + "name": "AKSAssessmentOperations" + }, + { + "name": "AssessedWebApplicationOperations" + }, + { + "name": "AKSOptionsOperations" + }, + { + "name": "AKSSummaryOperations" + }, + { + "name": "AKSClusterOperations" + }, + { + "name": "AKSCostDetailOperations" + } + ], + "paths": { + "/providers/Microsoft.Migrate/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources by resource group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}": { + "get": { + "operationId": "AssessmentProjectsOperations_Get", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Get a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentProjectsOperations_Create", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Create a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AssessmentProject' update operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "201": { + "description": "Resource 'AssessmentProject' create operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "AssessmentProjectsOperations_Update", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Update a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentProjectsOperations_Delete", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Delete a AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions": { + "get": { + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "tags": [ + "AKSOptionsOperations" + ], + "description": "List AKSAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AksOptionsOperations_Get", + "tags": [ + "AKSOptionsOperations" + ], + "description": "Get a AKSAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "AKS Assessment Options Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments": { + "get": { + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "List AKSAssessment resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}": { + "get": { + "operationId": "AksAssessmentOperations_Get", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AksAssessmentOperations_Create", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Create a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AKSAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "201": { + "description": "Resource 'AKSAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AksAssessmentOperations_Delete", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Delete a AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "List AssessedWebApplication resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps/{assessedWorkload}": { + "get": { + "operationId": "AssessedWebApplicationOperations_Get", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "Get a AssessedWebApplication", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWorkload", + "in": "path", + "description": "Assessed Web Application Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters": { + "get": { + "operationId": "AksClusterOperations_ListByAksAssessment", + "tags": [ + "AKSClusterOperations" + ], + "description": "List AKSCluster resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksClusterOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters/{clusterName}": { + "get": { + "operationId": "AksClusterOperations_Get", + "tags": [ + "AKSClusterOperations" + ], + "description": "Get a AKSCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "clusterName", + "in": "path", + "description": "AKS Cluster Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksClusterOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/costDetails": { + "get": { + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "tags": [ + "AKSCostDetailOperations" + ], + "description": "List AKSCostDetail resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCostDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AksAssessmentOperations_DownloadUrl", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get URL for downloading AKS Assessment Report.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "AksSummaryOperations_ListByAksAssessment", + "tags": [ + "AKSSummaryOperations" + ], + "description": "List AKSSummary resources by AKSAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "AksSummaryOperations_Get", + "tags": [ + "AKSSummaryOperations" + ], + "description": "Get a AKSSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "AKS Assessment Summary Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions": { + "get": { + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "List AssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AssessmentOptionsOperations_Get", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "Get a AssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": " assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "List AvsAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_Get", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "Get a AvsAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessmentOptionsName", + "in": "path", + "description": "AVS Assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases": { + "get": { + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "tags": [ + "BusinessCaseOperations" + ], + "description": "List BusinessCase resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}": { + "get": { + "operationId": "BusinessCaseOperations_Get", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Get a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BusinessCaseOperations_Create", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Create a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BusinessCase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BusinessCase' update operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "201": { + "description": "Resource 'BusinessCase' create operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "BusinessCaseOperations_Delete", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Delete a BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "List AvsSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries/{avsSummaryName}": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "Get a AvsSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsSummaryName", + "in": "path", + "description": "Gets the Name of the Avs Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/compareSummary": { + "post": { + "operationId": "BusinessCaseOperations_CompareSummary", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get Compare summary report for Business case.", + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CompareSummary" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_CompareSummary_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "List EvaluatedAvsMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines/{evaluatedAvsMachineName}": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_Get", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "Get a EvaluatedAvsMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedAvsMachineName", + "in": "path", + "description": "Business case Evaluated AVS machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines": { + "get": { + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "List EvaluatedMachine resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines/{evaluatedMachineName}": { + "get": { + "operationId": "EvaluatedMachinesOperations_Get", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "Get a EvaluatedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedMachineName", + "in": "path", + "description": "Business case Evaluated machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "List EvaluatedSqlEntity resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities/{evaluatedSqlEntityName}": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "Get a EvaluatedSqlEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedSqlEntityName", + "in": "path", + "description": "Business case Evaluated sql entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps": { + "get": { + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "List EvaluatedWebApp resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps/{evaluatedWebAppName}": { + "get": { + "operationId": "EvaluatedWebAppsOperations_Get", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "Get a EvaluatedWebApp", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedWebAppName", + "in": "path", + "description": "Business case Evaluated web App ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/getReportDownloadUrl": { + "post": { + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get download URL for the business case report.", + "description": "Get the URL for downloading the business case in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportDownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "List IaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "Get a IaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "iaasSummaryName", + "in": "path", + "description": "Gets the Name of the Iaas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "List OverviewSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "Get a OverviewSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "overviewSummaryName", + "in": "path", + "description": "Gets the Name of the Overview Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "List PaasSummary resources by BusinessCase", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_Get", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "Get a PaasSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "paasSummaryName", + "in": "path", + "description": "Gets the Name of the Paas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups": { + "get": { + "operationId": "GroupsOperations_ListByAssessmentProject", + "tags": [ + "GroupsOperations" + ], + "description": "List Group resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GroupsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}": { + "get": { + "operationId": "GroupsOperations_Get", + "tags": [ + "GroupsOperations" + ], + "description": "Get a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "GroupsOperations_Create", + "tags": [ + "GroupsOperations" + ], + "description": "Create a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Group" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Group' update operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "201": { + "description": "Resource 'Group' create operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "GroupsOperations_Delete", + "tags": [ + "GroupsOperations" + ], + "description": "Delete a Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments": { + "get": { + "operationId": "AssessmentsOperations_ListByGroup", + "tags": [ + "AssessmentsOperations" + ], + "description": "List Assessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}": { + "get": { + "operationId": "AssessmentsOperations_Get", + "tags": [ + "AssessmentsOperations" + ], + "description": "Get a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentsOperations_Create", + "tags": [ + "AssessmentsOperations" + ], + "description": "Create a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Assessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Assessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "201": { + "description": "Resource 'Assessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentsOperations_Delete", + "tags": [ + "AssessmentsOperations" + ], + "description": "Delete a Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines": { + "get": { + "operationId": "AssessedMachinesOperations_ListByAssessment", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "List AssessedMachine resources by Assessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { + "get": { + "operationId": "AssessedMachinesOperations_Get", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "Get a AssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedMachineName", + "in": "path", + "description": "Machine assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AssessmentsOperations_DownloadUrl", + "tags": [ + "AssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments": { + "get": { + "operationId": "AvsAssessmentsOperations_ListByGroup", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "List AvsAssessment resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}": { + "get": { + "operationId": "AvsAssessmentsOperations_Get", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Get a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AvsAssessmentsOperations_Create", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Create a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AvsAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "201": { + "description": "Resource 'AvsAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AvsAssessmentsOperations_Delete", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Delete a AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines": { + "get": { + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "List AvsAssessedMachine resources by AvsAssessment", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}": { + "get": { + "operationId": "AvsAssessedMachinesOperations_Get", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "Get a AvsAssessedMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessedMachineName", + "in": "path", + "description": "AVS assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "tags": [ + "AvsAssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments": { + "get": { + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "List SqlAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}": { + "get": { + "operationId": "SqlAssessmentV2Operations_Get", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Get a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlAssessmentV2Operations_Create", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Create a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "201": { + "description": "Resource 'SqlAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlAssessmentV2Operations_Delete", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Delete a SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "List AssessedSqlDatabaseV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "Get a AssessedSqlDatabaseV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlDatabaseName", + "in": "path", + "description": "Sql assessment Assessed Databases ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "List AssessedSqlInstanceV2 resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_Get", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "Get a AssessedSqlInstanceV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlInstanceName", + "in": "path", + "description": "Sql assessment Assessed Instance ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines": { + "get": { + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "List AssessedSqlMachine resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}": { + "get": { + "operationId": "AssessedSqlMachinesOperations_Get", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "Get a AssessedSqlMachine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlMachineName", + "in": "path", + "description": "Sql assessment Assessed Machine ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "tags": [ + "SqlAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "List AssessedSqlRecommendedEntity resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "Get a AssessedSqlRecommendedEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "recommendedAssessedEntityName", + "in": "path", + "description": "Sql assessment Assessed Recommended Entity ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "List SqlAssessmentV2Summary resources by SqlAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "Get a SqlAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the SQL Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines": { + "post": { + "operationId": "GroupsOperations_UpdateMachines", + "tags": [ + "GroupsOperations" + ], + "summary": "Update machines in group.", + "description": "Update machines in group by adding or removing machines.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGroupBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_UpdateMachines_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments": { + "get": { + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "List WebAppAssessmentV2 resources by Group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}": { + "get": { + "operationId": "WebAppAssessmentV2Operations_Get", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Get a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppAssessmentV2Operations_Create", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Create a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "201": { + "description": "Resource 'WebAppAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppAssessmentV2Operations_Delete", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Delete a WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "List AssessedWebAppV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps/{assessedWebAppName}": { + "get": { + "operationId": "AssessedWebAppV2Operations_Get", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "Get a AssessedWebAppV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWebAppName", + "in": "path", + "description": "Assessed web app ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "List WebAppAssessmentV2Summary resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "Get a WebAppAssessmentV2Summary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the Web app Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans": { + "get": { + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "List WebAppServicePlanV2 resources by WebAppAssessmentV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans/{webAppServicePlanName}": { + "get": { + "operationId": "WebAppServicePlanV2Operations_Get", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "Get a WebAppServicePlanV2", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "webAppServicePlanName", + "in": "path", + "description": "Web app service plan ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors": { + "get": { + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "List HypervCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}": { + "get": { + "operationId": "HypervCollectorsOperations_Get", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Get a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervCollectorsOperations_Create", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Create a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HypervCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "201": { + "description": "Resource 'HypervCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervCollectorsOperations_Delete", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Delete a HypervCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors": { + "get": { + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "List ImportCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}": { + "get": { + "operationId": "ImportCollectorsOperations_Get", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Get a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportCollectorsOperations_Create", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Create a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ImportCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "201": { + "description": "Resource 'ImportCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ImportCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportCollectorsOperations_Delete", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Delete a ImportCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines": { + "get": { + "operationId": "MachinesOperations_ListByAssessmentProject", + "tags": [ + "MachinesOperations" + ], + "description": "List Machine resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}": { + "get": { + "operationId": "MachinesOperations_Get", + "tags": [ + "MachinesOperations" + ], + "description": "Get a Machine", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Assessible Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "List PrivateEndpointConnection resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_Get", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Get a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionOperations_Update", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Create a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionOperations_Delete", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Delete a PrivateEndpointConnection", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "List PrivateLinkResource resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourceOperations_Get", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "Get a PrivateLinkResource", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "List AssessmentProjectSummary resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_Get", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "Get a AssessmentProjectSummary", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "projectSummaryName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors": { + "get": { + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "List ServerCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}": { + "get": { + "operationId": "ServerCollectorsOperations_Get", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Get a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerCollectorsOperations_Create", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Create a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ServerCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "201": { + "description": "Resource 'ServerCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerCollectorsOperations_Delete", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Delete a ServerCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "List SqlAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_Get", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "Get a SqlAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Sql assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors": { + "get": { + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "tags": [ + "SqlCollectorOperations" + ], + "description": "List SqlCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}": { + "get": { + "operationId": "SqlCollectorOperations_Get", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Get a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlCollectorOperations_Create", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Create a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "201": { + "description": "Resource 'SqlCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlCollectorOperations_Delete", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Delete a SqlCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors": { + "get": { + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "List VmwareCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}": { + "get": { + "operationId": "VmwareCollectorsOperations_Get", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Get a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VmwareCollectorsOperations_Create", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Create a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VmwareCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "201": { + "description": "Resource 'VmwareCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwareCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VmwareCollectorsOperations_Delete", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Delete a VmwareCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "List WebAppAssessmentOptions resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_Get", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "Get a WebAppAssessmentOptions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Web app assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors": { + "get": { + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "List WebAppCollector resources by AssessmentProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}": { + "get": { + "operationId": "WebAppCollectorOperations_Get", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Get a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppCollectorOperations_Create", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Create a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "201": { + "description": "Resource 'WebAppCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppCollectorOperations_Delete", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Delete a WebAppCollector", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AKSAssessment": { + "type": "object", + "description": "ARM model of AKS Assessment.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentDetails": { + "type": "object", + "description": "Data model of AKS Assessment Details.", + "properties": { + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentDetails" + } + ] + }, + "AKSAssessmentListResult": { + "type": "object", + "description": "The response of a AKSAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessment items on this page", + "items": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptions": { + "type": "object", + "description": "ARM model of AKS Assessment Options.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AKSAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptionsProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Options Properties.", + "allOf": [ + { + "$ref": "#/definitions/OptionsArmPropertiesBase" + } + ] + }, + "AKSAssessmentProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Properties.", + "properties": { + "settings": { + "$ref": "#/definitions/AKSAssessmentSettings", + "description": "Gets or sets AKS Assessment Settings." + }, + "details": { + "$ref": "#/definitions/AKSAssessmentDetails", + "description": "Gets AKS Assessment Details.", + "readOnly": true + } + }, + "required": [ + "settings" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentPropertiesBase" + } + ] + }, + "AKSAssessmentSettings": { + "type": "object", + "description": "Data model of AKS Assessment Settings.", + "properties": { + "category": { + "$ref": "#/definitions/AzureVmCategory", + "description": "Gets or sets azure VM category." + }, + "savingsOptions": { + "$ref": "#/definitions/SavingsOptions", + "description": "Gets or sets savings options." + }, + "consolidation": { + "$ref": "#/definitions/ConsolidationType", + "description": "Gets or sets consolidation type." + }, + "pricingTier": { + "$ref": "#/definitions/PricingTier", + "description": "Gets or sets pricing tier." + } + }, + "required": [ + "category", + "savingsOptions", + "consolidation", + "pricingTier" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentSettings" + } + ] + }, + "AKSAssessmentSummary": { + "type": "object", + "description": "Data model of AKS Assessment Summary.", + "properties": { + "skuSummary": { + "type": "object", + "description": "Gets SKU summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Gets web app summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Gets web server summary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "skuSummary", + "webAppSummary", + "webServerSummary", + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ] + }, + "AKSCluster": { + "type": "object", + "description": "ARM model of AKS Cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSClusterListResult": { + "type": "object", + "description": "The response of a AKSCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCluster items on this page", + "items": { + "$ref": "#/definitions/AKSCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSClusterProperties": { + "type": "object", + "description": "ARM model of AKS Cluster Properties.", + "allOf": [ + { + "$ref": "#/definitions/Cluster" + } + ] + }, + "AKSCostDetail": { + "type": "object", + "description": "ARM model of AKS Cost Detail.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSCostDetailProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSCostDetailListResult": { + "type": "object", + "description": "The response of a AKSCostDetail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCostDetail items on this page", + "items": { + "$ref": "#/definitions/AKSCostDetail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSCostDetailProperties": { + "type": "object", + "description": "ARM model of AKS Cost Detail Properties.", + "allOf": [ + { + "$ref": "#/definitions/NodePool" + } + ] + }, + "AKSSummary": { + "type": "object", + "description": "ARM model of AKS Summary.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSSummaryListResult": { + "type": "object", + "description": "The response of a AKSSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSSummary items on this page", + "items": { + "$ref": "#/definitions/AKSSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSSummaryProperties": { + "type": "object", + "description": "ARM model of AKS Summary Properties.", + "properties": { + "aksAssessmentSummary": { + "$ref": "#/definitions/AKSAssessmentSummary", + "description": "Gets AKS assessment summary.", + "readOnly": true + } + }, + "required": [ + "aksAssessmentSummary" + ], + "allOf": [ + { + "$ref": "#/definitions/SummaryPropertiesBase" + } + ] + }, + "ApiVersions": { + "type": "string", + "description": "Common API Versions for Assessment Project Tracked Resource.", + "enum": [ + "2019-10-01", + "2020-01-01", + "2020-05-01-preview", + "2022-02-02-preview", + "2022-08-01-preview", + "2023-03-03", + "2023-03-15", + "2023-04-01-preview", + "2023-05-01-preview", + "2023-07-07-preview", + "2023-09-09-preview", + "2024-01-01-preview" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "v2019_10_01", + "value": "2019-10-01", + "description": "2019-10-01 API Version." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "2020-01-01 API Version." + }, + { + "name": "v2020_05_01_preview", + "value": "2020-05-01-preview", + "description": "2020-05-01-preview API Version." + }, + { + "name": "v2022_02_02_preview", + "value": "2022-02-02-preview", + "description": "2022-02-02-preview API Version." + }, + { + "name": "v2022_08_01_preview", + "value": "2022-08-01-preview", + "description": "2022-08-01-preview API Version." + }, + { + "name": "v2023_03_03", + "value": "2023-03-03", + "description": "2023-03-03 API Version." + }, + { + "name": "v2023_03_15", + "value": "2023-03-15", + "description": "2023-03-15 API Version." + }, + { + "name": "v2023_04_01_preview", + "value": "2023-04-01-preview", + "description": "2023-04-01-preview API Version." + }, + { + "name": "v2023_05_01_preview", + "value": "2023-05-01-preview", + "description": "2023-05-01-preview API Version." + }, + { + "name": "v2023_07_07_preview", + "value": "2023-07-07-preview", + "description": "2023-07-07-preview API Version." + }, + { + "name": "v2023_09_09_preview", + "value": "2023-09-09-preview", + "description": "2023-09-09-preview API Version." + }, + { + "name": "v2024_01_01_preview", + "value": "2024-01-01-preview", + "description": "2024-01-01-preview API Version." + } + ] + } + }, + "AppServiceSku": { + "type": "object", + "description": "The app service SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans recommended.", + "readOnly": true + } + } + }, + "AppSvcContainerSettings": { + "type": "object", + "description": "App service container settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AppSvcNativeSettings": { + "type": "object", + "description": "App service native settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AssessedDisk": { + "type": "object", + "description": "Assessed disk properties class.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "gigabytesForRecommendedDiskSize": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedDiskData": { + "type": "object", + "description": "Assessed Disk data. Used in Assessed SQL machine DTO.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "recommendedDiskSizeGigabytes": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedMachine": { + "type": "object", + "description": "Machine assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedMachineListResult": { + "type": "object", + "description": "The response of a AssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedMachineProperties": { + "type": "object", + "description": "Assessed machine properties class.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDisk" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly ultra storage cost.", + "readOnly": true + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets or sets the processor details of the host." + }, + "costComponents": { + "type": "array", + "description": "Gets or sets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly premium storage cost.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly standard SSD storage cost.", + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedNetworkAdapter" + }, + "readOnly": true + }, + "recommendedSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Recommended Azure Size for the machine.", + "readOnly": true + }, + "numberOfCoresForRecommendedSize": { + "type": "integer", + "format": "int32", + "description": "Number of cores for recommended size. Read Only.", + "readOnly": true + }, + "megabytesOfMemoryForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Megabytes of memory for recommended size. Read Only.", + "readOnly": true + }, + "monthlyComputeCostForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Monthly Compute cost calculated for Recommended size, for a 31-day month.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AssessedMachineType": { + "type": "string", + "enum": [ + "Unknown", + "AssessedMachine", + "AvsAssessedMachine", + "SqlAssessedMachine" + ], + "x-ms-enum": { + "name": "AssessedMachineType", + "modelAsString": true + } + }, + "AssessedNetworkAdapter": { + "type": "object", + "description": "Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "AssessedSqlDatabaseV2": { + "type": "object", + "description": "Assessed SQL database web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlDatabaseV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlDatabaseV2Properties": { + "type": "object", + "description": "Assessed SQL database properties web model.", + "properties": { + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "bufferCacheSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregated cache size of this database. This is a performance\ndata metric for this DB.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL DB suitability details.", + "readOnly": true + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets a value indicating whether the assessed SQL database is highly available\nor not.", + "readOnly": true + }, + "linkedAvailabilityGroupOverview": { + "$ref": "#/definitions/SqlAvailabilityGroupDataOverview", + "description": "Gets the linked availability group overview if the database being assessed is\nhighly available.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "assessedSqlInstanceArmId": { + "type": "string", + "description": "Assessed SQL instance arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "SQL database name.", + "readOnly": true + }, + "databaseSizeInMB": { + "type": "number", + "format": "float", + "description": "SQL database size in megabytes.", + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Database compatibility level.", + "readOnly": true + }, + "sqlDatabaseSdsArmId": { + "type": "string", + "description": "SQL database SDS arm id.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "The read throughput of the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "The write throughput of the SQL database.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The read operations per second of the SQL database.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The write operations per second of the SQL database.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database last updated.", + "readOnly": true + } + } + }, + "AssessedSqlInstanceDatabaseSummary": { + "type": "object", + "description": "Assessed Sql Instance Database Summary.", + "properties": { + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the number of user databases." + }, + "totalDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the total database size in MB." + }, + "largestDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the largest database size in MB." + }, + "totalDiscoveredUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the total discovered user databases." + } + } + }, + "AssessedSqlInstanceDiskDetails": { + "type": "object", + "description": "Assessed Sql Instance Disk Details.", + "properties": { + "diskId": { + "type": "string", + "description": "Gets the disk id." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceStorageDetails": { + "type": "object", + "description": "Assessed Sql Instance Storage Details.", + "properties": { + "storageType": { + "type": "string", + "description": "Gets the storage type." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceSummary": { + "type": "object", + "description": "Assessed Sql Instance Summary.", + "properties": { + "instanceId": { + "type": "string", + "description": "Gets the instance id." + }, + "instanceName": { + "type": "string", + "description": "Gets the instance name." + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "Gets the instance arm id." + }, + "sqlInstanceEntityId": { + "type": "string", + "description": "Gets the instance entity id." + }, + "sqlEdition": { + "type": "string", + "description": "Gets the Sql edition." + }, + "sqlVersion": { + "type": "string", + "description": "Gets the Sql version." + }, + "isClustered": { + "type": "boolean", + "description": "Gets whether Sql is clustered." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets whether Sql is highly available." + }, + "sqlFciState": { + "$ref": "#/definitions/SqlFCIState", + "description": "Gets the Sql Fci state." + } + } + }, + "AssessedSqlInstanceV2": { + "type": "object", + "description": "Assessed SQL instance web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlInstanceV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlInstanceV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlInstanceV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlInstanceV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlInstanceV2Properties": { + "type": "object", + "description": "Assessed SQL instance properties web model.", + "properties": { + "memoryInUseInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the memory used by SQL instance in megabytes.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether SQL instance has been deep discovered.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "storageTypeBasedDetails": { + "type": "array", + "description": "Gets the storage details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceStorageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "fciMetadata": { + "$ref": "#/definitions/SqlFCIMetadata", + "description": "Gets the FCI metadata if this instance represents an FCI instance.", + "readOnly": true + }, + "availabilityReplicaSummary": { + "$ref": "#/definitions/SqlAvailabilityReplicaSummary", + "description": "Gets the overview counts of availability replicas in the assessed instance, by\ncommit mode and read type.", + "readOnly": true + }, + "isClustered": { + "type": "boolean", + "description": "Gets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "recommendedTargetReasonings": { + "type": "array", + "description": "Gets the list of recommended target reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "SQL instance SDS arm id.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL instance edition.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL instance version.", + "readOnly": true + }, + "numberOfCoresAllocated": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores assigned to the SQL instance.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL instance.", + "readOnly": true + }, + "logicalDisks": { + "type": "array", + "description": "The logical disk details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceDiskDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "databaseSummary": { + "$ref": "#/definitions/AssessedSqlInstanceDatabaseSummary", + "description": "The databases summary.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance last updated.", + "readOnly": true + } + } + }, + "AssessedSqlMachine": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlMachineListResult": { + "type": "object", + "description": "The response of a AssessedSqlMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlMachineProperties": { + "type": "object", + "description": "Assessed SQL machine properties.", + "properties": { + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID for the machine.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN for the machine.", + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "Gets the list of SQL instances discovered on the machine.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets or sets the detailed messages that were set on the machine during\nevaluation.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets or sets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "recommendedVmSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets or sets the Recommended Azure Size for the machine.", + "readOnly": true + }, + "recommendedVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets or sets the Recommended Azure VM Family for the machine.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "recommendedVmSizeNumberOfCores": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of cores for recommended size.", + "readOnly": true + }, + "recommendedVmSizeMegabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Gets or sets the Megabytes of memory for recommended size.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly compute cost calculated for recommended size.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Gets the list of data disks that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDiskData" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Gets the list of network adapters that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessedNetworkAdapter" + }, + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly total storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedSqlRecommendedEntity": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedSqlRecommendedEntityListResult": { + "type": "object", + "description": "The response of a AssessedSqlRecommendedEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlRecommendedEntity items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlRecommendedEntityProperties": { + "type": "object", + "description": "Assessed SQL recommended entity properties.", + "properties": { + "machineName": { + "type": "string", + "description": "Gets or sets machine name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "Gets or sets SQL instance name.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets assessed database count.", + "readOnly": true + }, + "discoveredDBCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total discovered database count.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether instance deep discovery has occurred or\nnot.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "assessedSqlEntityArmId": { + "type": "string", + "description": "Gets or sets Arm id of assessed entity." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "Gets the SQL edition from the recommended entity if applicable.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "Gets the SQL version from the recommended entity if applicable.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedWebApp": { + "type": "object", + "description": "Data model of Assessed Web App.", + "properties": { + "suitabilityResult": { + "$ref": "#/definitions/SuitabilityResult", + "description": "Gets suitability result.", + "readOnly": true + }, + "recommendationResult": { + "$ref": "#/definitions/RecommendationResult", + "description": "Gets recommendation result.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/WebApp" + } + ] + }, + "AssessedWebAppV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebAppV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebAppV2ListResult": { + "type": "object", + "description": "The response of a AssessedWebAppV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebAppV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebAppV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "targetSpecificResult": { + "type": "object", + "description": "Gets or sets the target specific result.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificResult" + }, + "readOnly": true + }, + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Gets the machine name.", + "readOnly": true + }, + "serverArmId": { + "type": "string", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "webAppName": { + "type": "string", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "discoveredWebAppId": { + "type": "string", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "discoveredMachineId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + } + }, + "required": [ + "appServicePlanName", + "machineName" + ] + }, + "AssessedWebApplication": { + "type": "object", + "description": "ARM model of Assessed Web Application.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebApplicationListResult": { + "type": "object", + "description": "The response of a AssessedWebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebApplication items on this page", + "items": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebApplicationProperties": { + "type": "object", + "description": "ARM model of Assessed Web Application Properties.", + "allOf": [ + { + "$ref": "#/definitions/AssessedWebApp" + } + ] + }, + "Assessment": { + "type": "object", + "description": "Machine assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentDetails": { + "type": "object", + "description": "Data model of Details of Assessment Computation.", + "properties": { + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets last time when rates were queried.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Gets Confidence score.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Gets assessment status.", + "readOnly": true + } + }, + "required": [ + "createdTimestamp", + "updatedTimestamp", + "status" + ] + }, + "AssessmentListResult": { + "type": "object", + "description": "The response of a Assessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Assessment items on this page", + "items": { + "$ref": "#/definitions/Assessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptions": { + "type": "object", + "description": "Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptionsProperties": { + "type": "object", + "description": "Assessment options properties.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Dictionary of VM families grouped by vm family name describing the targeted\nazure locations of VM family and the category of the family.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "List of supported VM Families.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ultraDiskVmFamilies": { + "type": "array", + "description": "Ultra disk related assessment options.", + "items": { + "$ref": "#/definitions/UltraDiskAssessmentOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "List of VM Families that support premium disks for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "List of VM Families that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "List of Azure locations that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "premiumV2DiskSupportedLocations": { + "type": "array", + "description": "List of Azure locations that support Premium SSD V2 disks for assessments.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "readOnly": true + } + } + }, + "AssessmentProject": { + "type": "object", + "description": "An Assessment project site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AssessmentProjectListResult": { + "type": "object", + "description": "The response of a AssessmentProject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProject items on this page", + "items": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummary": { + "type": "object", + "description": "Assessment project summary resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentProjectSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessmentProjectSummaryListResult": { + "type": "object", + "description": "The response of a AssessmentProjectSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProjectSummary items on this page", + "items": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummaryProperties": { + "type": "object", + "description": "Assessment project summary properties class.", + "properties": { + "errorSummaryAffectedEntities": { + "type": "array", + "description": "Gets the Error summary by feature. Contains number of affected Entities per\nfeature.", + "items": { + "$ref": "#/definitions/ErrorSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfPrivateEndpointConnections": { + "type": "integer", + "format": "int32", + "description": "Gets the number of private endpoint connections.", + "readOnly": true + }, + "numberOfGroups": { + "type": "integer", + "format": "int32", + "description": "Gets the number of groups created in this project.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines part of this project.", + "readOnly": true + }, + "numberOfImportMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of import machines part of this project.", + "readOnly": true + }, + "numberOfAssessments": { + "type": "integer", + "format": "int32", + "description": "Gets the number of assessments created in this project.", + "readOnly": true + }, + "lastAssessmentTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the last assessment timestamp.", + "readOnly": true + } + } + }, + "AssessmentProjectUpdate": { + "type": "object", + "description": "The type used for update operations of the AssessmentProject.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssessmentProjectUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssessmentProjectUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AssessmentProject.", + "properties": { + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AssessmentPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment ARM properties.", + "properties": { + "scope": { + "$ref": "#/definitions/AssessmentScopeParameters", + "description": "Gets or sets scope parameters to identify inventory items for assessment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MutableArmResource" + } + ] + }, + "AssessmentResult": { + "type": "object", + "description": "Assessment results.", + "properties": { + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name." + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the suitability." + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the security suitability." + }, + "webAppSkuName": { + "type": "string", + "description": "Gets or sets the web app sku name." + }, + "webAppSkuSize": { + "type": "string", + "description": "Gets or sets the web app sku size." + } + }, + "required": [ + "appServicePlanName", + "suitability", + "securitySuitability", + "webAppSkuName", + "webAppSkuSize" + ] + }, + "AssessmentScopeParameters": { + "type": "object", + "description": "Data model of Assessment Scope Parameters.", + "properties": { + "serverGroupId": { + "type": "string", + "description": "Gets or sets the server group id." + } + } + }, + "AssessmentSettings": { + "type": "object", + "description": "Base data model of Assessment Settings.", + "properties": { + "azureLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "environmentType": { + "$ref": "#/definitions/AzureEnvironmentType", + "description": "Gets or sets environment type." + }, + "licensingProgram": { + "$ref": "#/definitions/LicensingProgram", + "description": "Gets or sets licensing program." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Gets or sets currency." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets or sets discount percentage." + }, + "sizingCriteria": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Gets or sets sizing criteria." + }, + "performanceData": { + "$ref": "#/definitions/PerfDataSettings", + "description": "Gets or sets performance data settings." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Gets or sets scaling factor." + } + }, + "required": [ + "azureLocation", + "environmentType", + "licensingProgram", + "currency", + "sizingCriteria" + ] + }, + "AssessmentSizingCriterion": { + "type": "string", + "description": "Assessment Sizing Criteria.", + "enum": [ + "PerformanceBased", + "AsOnPremises" + ], + "x-ms-enum": { + "name": "AssessmentSizingCriterion", + "modelAsString": true, + "values": [ + { + "name": "PerformanceBased", + "value": "PerformanceBased", + "description": "Performance Data based Sizing." + }, + { + "name": "AsOnPremises", + "value": "AsOnPremises", + "description": "As On Premises or Static Data based Sizing." + } + ] + } + }, + "AssessmentStage": { + "type": "string", + "enum": [ + "InProgress", + "UnderReview", + "Approved" + ], + "x-ms-enum": { + "name": "AssessmentStage", + "modelAsString": true + } + }, + "AssessmentStatus": { + "type": "string", + "description": "Assessment Status.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid", + "OutOfSync", + "OutDated", + "Deleted" + ], + "x-ms-enum": { + "name": "AssessmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Assessment is Created." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Assessment is Updated." + }, + { + "name": "Running", + "value": "Running", + "description": "Assessment is currently running." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Assessment is Completed or Ready." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Assessment is Failed i.e. it is now invalid." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "Assessment is Out of Sync." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "Assessment is Out Dated." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Assessment is Deleted." + } + ] + } + }, + "AssessmentType": { + "type": "string", + "enum": [ + "Unknown", + "MachineAssessment", + "AvsAssessment", + "SqlAssessment", + "WebAppAssessment" + ], + "x-ms-enum": { + "name": "AssessmentType", + "modelAsString": true + } + }, + "AsyncCommitModeIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "AsyncCommitModeIntent", + "modelAsString": true + } + }, + "AvsAssessedDisk": { + "type": "object", + "description": "AVS assessed disk web model class.", + "properties": { + "name": { + "type": "string", + "description": "Gets the ID of the disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the disk.", + "readOnly": true + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gigabytes Provisioned for a disk in private data center.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk Read Throughput in MB/s.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk Write Throughput in MB/s.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Read Operations per second.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Write Operations per second.", + "readOnly": true + }, + "assessedExternalStorageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Associated storage Type recommended for Disk.", + "readOnly": true + }, + "estimatedDiskSizeInGB": { + "type": "number", + "format": "float", + "description": "Estimated Disk Size in GB.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail.", + "readOnly": true + } + } + }, + "AvsAssessedMachine": { + "type": "object", + "description": "AVS assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessedMachineListResult": { + "type": "object", + "description": "The response of a AvsAssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessedMachineProperties": { + "type": "object", + "description": "AVS assessed machine properties web model.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "List of Disks that were assessed as part of this machine's assessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedDisk" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedNetworkAdapter" + }, + "readOnly": true + }, + "storageInUseGB": { + "type": "number", + "format": "float", + "description": "Gets the storage in use.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureAvsVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AvsAssessedNetworkAdapter": { + "type": "object", + "description": "Second level object returned as part of AVS AssessedMachine REST resource.", + "properties": { + "macAddress": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP V4 addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network adapter.", + "readOnly": true + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the Received data for Network Adapter in MB/s.\n This value is\nthe percentile of historical data based on options selected in Assessment.", + "readOnly": true + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the Transmitted data for Network Adapter in MB/s.\n This value\nis the percentile of historical data based on options selected in Assessment.", + "readOnly": true + } + } + }, + "AvsAssessment": { + "type": "object", + "description": "AVS assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentListResult": { + "type": "object", + "description": "The response of a AvsAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessment items on this page", + "items": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptions": { + "type": "object", + "description": "AVS Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AvsAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptionsProperties": { + "type": "object", + "description": "AVS Assessment options properties.", + "properties": { + "avsNodes": { + "type": "array", + "description": "AVS SKU Nodes.", + "items": { + "$ref": "#/definitions/AvsSkuOptions" + }, + "x-ms-identifiers": [] + }, + "avsExternalStorageTypes": { + "type": "array", + "description": "AVS External Storage Types Supported.", + "items": { + "$ref": "#/definitions/AvsExternalStorageOptions" + }, + "x-ms-identifiers": [] + }, + "failuresToTolerateAndRaidLevelValues": { + "type": "array", + "description": "FTT and Raid level values.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "reservedInstanceAvsNodes": { + "type": "array", + "description": "List of AVS nodes for RI.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + } + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + } + } + } + }, + "AvsAssessmentProperties": { + "type": "object", + "description": "Properties of the AVS assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level in a common property." + }, + "failuresToTolerateAndRaidLevelList": { + "type": "array", + "description": "List of Failures to tolerate and RAID levels in a common property.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "vcpuOversubscription": { + "type": "number", + "format": "float", + "description": "VCPU over subscription." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS node type." + }, + "nodeTypes": { + "type": "array", + "description": "AVS node types.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "externalStorageTypes": { + "type": "array", + "description": "List of AVS external storage types.", + "items": { + "$ref": "#/definitions/ExternalStorageType" + } + }, + "avsAssessmentScenario": { + "$ref": "#/definitions/AvsAssessmentScenario", + "description": "AVS Assessment Scenario." + }, + "isVcfByolEnabled": { + "type": "boolean", + "description": "Is VCF license applied" + }, + "costComponents": { + "type": "array", + "description": "collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the Assessment cloud suitability.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsSuitabilityExplanation", + "description": "Gets or sets the Assessment suitability explanation.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Recommended number of nodes.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization.", + "readOnly": true + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization.", + "readOnly": true + }, + "totalCpuCores": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores used.", + "readOnly": true + }, + "totalRamInGB": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB.", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB.", + "readOnly": true + }, + "avsEstimatedNodes": { + "type": "array", + "description": "Estimated AVS SKU for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNode" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedExternalStorages": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedNetworks": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "cpuHeadroom": { + "type": "number", + "format": "float", + "description": "Percentage of CPU capacity reserved for processing additional workloads." + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Cloud suitability summary for all the machines in the assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "memOvercommit": { + "type": "number", + "format": "float", + "description": "Memory overcommit." + }, + "dedupeCompression": { + "type": "number", + "format": "float", + "description": "De-duplication compression." + }, + "limitingFactor": { + "type": "string", + "description": "Limiting factor.", + "readOnly": true + }, + "isStretchClusterEnabled": { + "type": "boolean", + "description": "Is Stretch Cluster Enabled." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer code according to which cost estimation is done." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when the Azure Prices were queried. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "AvsExternalStorageOptions": { + "type": "object", + "description": "AVS External Storage specific options.", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "AVS external storage type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this storage type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsNodeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of Avs VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "avsNodeCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedAvsNodeTypeSummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedAvsNodeTypeSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedExternalStorage": { + "type": "array", + "description": "Estimated External Storage", + "items": { + "$ref": "#/definitions/EstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedNetwork": { + "type": "array", + "description": "Estimated Network", + "items": { + "$ref": "#/definitions/EstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedCostWithVcfByol": { + "type": "number", + "format": "float", + "description": "Estimated Cost With VCF BYOL", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Represents errors which might have occurred while calculating AVS Node Summary", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AvsEstimatedExternalStorage": { + "type": "object", + "description": "Details on the Estimated External Storage for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type of storage." + }, + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Recommended External Storage." + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + } + } + }, + "AvsEstimatedNetwork": { + "type": "object", + "description": "Details on the Estimated Network Costs for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Monthly cost for network type." + }, + "networkType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Recommended Network Sku." + } + } + }, + "AvsEstimatedNode": { + "type": "object", + "description": "Details on the Estimated nodes for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type and number of nodes." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "Recommended SKU." + }, + "nodeNumber": { + "type": "integer", + "format": "int32", + "description": "Number of nodes that will be needed." + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization." + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + }, + "totalCpu": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores across the set of nodes." + }, + "totalRam": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB." + }, + "totalStorage": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "pricingModel": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Pricing model indicates what hour multiplier to use while estimating the Nodes cost." + }, + "fttRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "FttRaidLevel recommended for Node." + } + } + }, + "AvsSkuOptions": { + "type": "object", + "description": "AVS SKU specific options.", + "properties": { + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS Node type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this node type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsSummary": { + "type": "object", + "description": "Avs summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvsSummaryListResult": { + "type": "object", + "description": "The response of a AvsSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsSummary items on this page", + "items": { + "$ref": "#/definitions/AvsSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsSummaryProperties": { + "type": "object", + "description": "Avs summary properties class.", + "properties": { + "azureAvsSummary": { + "$ref": "#/definitions/AzureAvsSummary", + "description": "The Azure Avs summary.", + "readOnly": true + }, + "onPremisesAvsSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "AzureAppServiceContainerSummary": { + "type": "object", + "description": "Shows Azure App Service Container summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAppServiceSummary": { + "type": "object", + "description": "Shows Azure App Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/AppServiceSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureArcManagementSettings": { + "type": "object", + "description": "Azure Arc Management settings.", + "properties": { + "monitoringSettings": { + "$ref": "#/definitions/AzureArcMonitoringSettings", + "description": "Gets the azure arc monitoring settings." + } + }, + "required": [ + "monitoringSettings" + ] + }, + "AzureArcMonitoringSettings": { + "type": "object", + "description": "Azure Arc Monitoring settings.", + "properties": { + "logsVolumeInGB": { + "type": "number", + "format": "float", + "description": "Logs volume settings." + }, + "alertRulesCount": { + "type": "integer", + "format": "int32", + "description": "Number of alert rules settings." + } + }, + "required": [ + "logsVolumeInGB", + "alertRulesCount" + ] + }, + "AzureArcSettings": { + "type": "object", + "description": "Azure arc settings for a business case.", + "properties": { + "azureArcState": { + "$ref": "#/definitions/AzureArcState", + "description": "AzureArc state indicates whether to include azure arc related costs in on-premises or not." + }, + "laborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets Azure arc labour cost percentage.", + "minimum": 0, + "maximum": 100 + }, + "managementSettings": { + "$ref": "#/definitions/AzureArcManagementSettings", + "description": "Management settings." + } + }, + "required": [ + "azureArcState" + ] + }, + "AzureArcState": { + "type": "string", + "description": "AzureArc state values.", + "enum": [ + "Disabled", + "Enabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AzureArcState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "AzureArc state disabled." + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "AzureArc state enabled." + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "AzureArc state unknown." + } + ] + } + }, + "AzureAvsNodeType": { + "type": "string", + "enum": [ + "Unknown", + "AV36", + "AV36P", + "AV52", + "AV64" + ], + "x-ms-enum": { + "name": "AzureAvsNodeType", + "modelAsString": true + } + }, + "AzureAvsSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "UnsupportedLocationForSelectedNode", + "InternalErrorInRecommendation", + "UnsupportedLocationForSelectedExternalStorageTypes" + ], + "x-ms-enum": { + "name": "AzureAvsSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureAvsSummary": { + "type": "object", + "description": "The Azure AVS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "avsNodeSummary": { + "$ref": "#/definitions/AvsNodeSummary", + "description": "Avs virtual machine summary.", + "readOnly": true + }, + "avsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureAvsVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange", + "PercentageOfStorageUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureAvsVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "IpV6NotSupported", + "UnsupportedOperatingSystem" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureCurrency": { + "type": "string", + "description": "Currency for Azure.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "AzureCurrency", + "modelAsString": true + } + }, + "AzureDiskSize": { + "type": "string", + "enum": [ + "Unknown", + "Standard_S4", + "Standard_S6", + "Standard_S10", + "Standard_S15", + "Standard_S20", + "Standard_S30", + "Standard_S40", + "Standard_S50", + "Standard_S60", + "Standard_S70", + "Standard_S80", + "Premium_P4", + "Premium_P6", + "Premium_P10", + "Premium_P15", + "Premium_P20", + "Premium_P30", + "Premium_P40", + "Premium_P50", + "Premium_P60", + "Premium_P70", + "Premium_P80", + "StandardSSD_E10", + "StandardSSD_E15", + "StandardSSD_E20", + "StandardSSD_E30", + "StandardSSD_E40", + "StandardSSD_E50", + "StandardSSD_E60", + "StandardSSD_E70", + "StandardSSD_E80", + "StandardSSD_E4", + "StandardSSD_E6", + "StandardSSD_E1", + "StandardSSD_E2", + "StandardSSD_E3", + "Premium_P1", + "Premium_P2", + "Premium_P3", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "StandardS4", + "value": "Standard_S4" + }, + { + "name": "StandardS6", + "value": "Standard_S6" + }, + { + "name": "StandardS10", + "value": "Standard_S10" + }, + { + "name": "StandardS15", + "value": "Standard_S15" + }, + { + "name": "StandardS20", + "value": "Standard_S20" + }, + { + "name": "StandardS30", + "value": "Standard_S30" + }, + { + "name": "StandardS40", + "value": "Standard_S40" + }, + { + "name": "StandardS50", + "value": "Standard_S50" + }, + { + "name": "StandardS60", + "value": "Standard_S60" + }, + { + "name": "StandardS70", + "value": "Standard_S70" + }, + { + "name": "StandardS80", + "value": "Standard_S80" + }, + { + "name": "PremiumP4", + "value": "Premium_P4" + }, + { + "name": "PremiumP6", + "value": "Premium_P6" + }, + { + "name": "PremiumP10", + "value": "Premium_P10" + }, + { + "name": "PremiumP15", + "value": "Premium_P15" + }, + { + "name": "PremiumP20", + "value": "Premium_P20" + }, + { + "name": "PremiumP30", + "value": "Premium_P30" + }, + { + "name": "PremiumP40", + "value": "Premium_P40" + }, + { + "name": "PremiumP50", + "value": "Premium_P50" + }, + { + "name": "PremiumP60", + "value": "Premium_P60" + }, + { + "name": "PremiumP70", + "value": "Premium_P70" + }, + { + "name": "PremiumP80", + "value": "Premium_P80" + }, + { + "name": "StandardSSDE10", + "value": "StandardSSD_E10" + }, + { + "name": "StandardSSDE15", + "value": "StandardSSD_E15" + }, + { + "name": "StandardSSDE20", + "value": "StandardSSD_E20" + }, + { + "name": "StandardSSDE30", + "value": "StandardSSD_E30" + }, + { + "name": "StandardSSDE40", + "value": "StandardSSD_E40" + }, + { + "name": "StandardSSDE50", + "value": "StandardSSD_E50" + }, + { + "name": "StandardSSDE60", + "value": "StandardSSD_E60" + }, + { + "name": "StandardSSDE70", + "value": "StandardSSD_E70" + }, + { + "name": "StandardSSDE80", + "value": "StandardSSD_E80" + }, + { + "name": "StandardSSDE4", + "value": "StandardSSD_E4" + }, + { + "name": "StandardSSDE6", + "value": "StandardSSD_E6" + }, + { + "name": "StandardSSDE1", + "value": "StandardSSD_E1" + }, + { + "name": "StandardSSDE2", + "value": "StandardSSD_E2" + }, + { + "name": "StandardSSDE3", + "value": "StandardSSD_E3" + }, + { + "name": "PremiumP1", + "value": "Premium_P1" + }, + { + "name": "PremiumP2", + "value": "Premium_P2" + }, + { + "name": "PremiumP3", + "value": "Premium_P3" + }, + { + "name": "Ultra", + "value": "Ultra" + }, + { + "name": "PremiumV2", + "value": "PremiumV2" + } + ] + } + }, + "AzureDiskSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "NumberOfReadOperationsPerSecondMissing", + "NumberOfWriteOperationsPerSecondMissing", + "MegabytesPerSecondOfReadMissing", + "MegabytesPerSecondOfWriteMissing", + "DiskGigabytesConsumedMissing", + "DiskGigabytesProvisionedMissing", + "NumberOfReadOperationsPerSecondOutOfRange", + "NumberOfWriteOperationsPerSecondOutOfRange", + "MegabytesPerSecondOfReadOutOfRange", + "MegabytesPerSecondOfWriteOutOfRange", + "DiskGigabytesConsumedOutOfRange", + "DiskGigabytesProvisionedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityDetail", + "modelAsString": true + } + }, + "AzureDiskSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "DiskSizeGreaterThanSupported", + "NoSuitableDiskSizeForIops", + "NoSuitableDiskSizeForThroughput", + "NoDiskSizeFoundInSelectedLocation", + "NoDiskSizeFoundForSelectedRedundancy", + "InternalErrorOccurredForDiskEvaluation", + "NoEaPriceFoundForDiskSize" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureDiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskType", + "modelAsString": true + } + }, + "AzureEnvironmentType": { + "type": "string", + "description": "Environment Type for Azure.", + "enum": [ + "Unknown", + "DevTest", + "Production" + ], + "x-ms-enum": { + "name": "AzureEnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "DevTest", + "value": "DevTest", + "description": "Development or Test Environment." + }, + { + "name": "Production", + "value": "Production", + "description": "Production Environment." + } + ] + } + }, + "AzureHybridUseBenefit": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "AzureHybridUseBenefit", + "modelAsString": true + } + }, + "AzureIaasSqlSummary": { + "type": "object", + "description": "Azure Iaas sql server summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Total SQL entities.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable SQL entities.", + "readOnly": true + }, + "azureSqlCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureIaasSummary": { + "type": "object", + "description": "The Azure IaaS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "azureIaasVmSummary": { + "$ref": "#/definitions/AzureIaasVmSummary", + "description": "Azure Iaas virtual machine summary.", + "readOnly": true + }, + "azureIaasSqlSummary": { + "$ref": "#/definitions/AzureIaasSqlSummary", + "description": "Azure Iaas sql server summary.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureIaasVmSummary": { + "type": "object", + "description": "Azure Iaas virtual machine summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of IaaS VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "azureVmCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureKubernetesServiceSummary": { + "type": "object", + "description": "Shows Azure Kubernetes Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureLocation": { + "type": "string", + "description": "Location for Azure.", + "enum": [ + "Unknown", + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyCentral", + "GermanyNortheast", + "ChinaNorth", + "ChinaEast", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast", + "FranceCentral", + "AustraliaCentral", + "SouthAfricaNorth", + "FranceSouth", + "AustraliaCentral2", + "SouthAfricaWest", + "GermanyNorth", + "GermanyWestCentral", + "NorwayEast", + "NorwayWest", + "ChinaEast2", + "ChinaNorth2", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UAECentral", + "UsNatEast", + "UsNatWest", + "UsSecEast", + "UsSecCentral", + "UsSecWest", + "SwedenCentral", + "QatarCentral" + ], + "x-ms-enum": { + "name": "AzureLocation", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTO": { + "type": "object", + "description": "Class representing an Azure Managed Disk SKU.", + "properties": { + "diskType": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskType", + "description": "Gets the Type (\"tier\") of disk - e.g. standard, premium, ultra.", + "readOnly": true + }, + "diskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the Size of the managed disk - e.g. P30, P40.", + "readOnly": true + }, + "diskRedundancy": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskRedundancy", + "description": "Gets disk redundancy - e.g. LRS, ZRS.", + "readOnly": true + }, + "storageCost": { + "type": "number", + "format": "float", + "description": "Gets the managed disk storage cost.", + "readOnly": true + }, + "recommendedSizeInGib": { + "type": "number", + "format": "float", + "description": "Gets the recommended in GB of the managed disk.", + "readOnly": true + }, + "recommendedThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended throughput in MBPS of the managed disk.", + "readOnly": true + }, + "recommendedIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended IOPS of the managed disk.", + "readOnly": true + } + } + }, + "AzureManagedDiskSkuDTODiskRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LRS", + "ZRS" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskRedundancy", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTODiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskType", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "MegabytesOfDataTransmittedMissing", + "MegabytesOfDataTransmittedOutOfRange", + "MegabytesOfDataRecievedMissing", + "MegabytesOfDataRecievedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityDetail", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "InternalErrorOccurred" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureOfferCode": { + "type": "string", + "enum": [ + "Unknown", + "MSAZR0003P", + "MSAZR0044P", + "MSAZR0059P", + "MSAZR0060P", + "MSAZR0062P", + "MSAZR0063P", + "MSAZR0064P", + "MSAZR0029P", + "MSAZR0022P", + "MSAZR0023P", + "MSAZR0148P", + "MSAZR0025P", + "MSAZR0036P", + "MSAZR0120P", + "MSAZR0121P", + "MSAZR0122P", + "MSAZR0123P", + "MSAZR0124P", + "MSAZR0125P", + "MSAZR0126P", + "MSAZR0127P", + "MSAZR0128P", + "MSAZR0129P", + "MSAZR0130P", + "MSAZR0111P", + "MSAZR0144P", + "MSAZR0149P", + "MSMCAZR0044P", + "MSMCAZR0059P", + "MSMCAZR0060P", + "MSMCAZR0063P", + "MSMCAZR0120P", + "MSMCAZR0121P", + "MSMCAZR0125P", + "MSMCAZR0128P", + "MSAZRDE0003P", + "MSAZRDE0044P", + "MSAZRUSGOV0003P", + "EA", + "MSAZR0243P", + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "AzureOfferCode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Msazr0003P", + "value": "MSAZR0003P" + }, + { + "name": "Msazr0044P", + "value": "MSAZR0044P" + }, + { + "name": "Msazr0059P", + "value": "MSAZR0059P" + }, + { + "name": "Msazr0060P", + "value": "MSAZR0060P" + }, + { + "name": "Msazr0062P", + "value": "MSAZR0062P" + }, + { + "name": "Msazr0063P", + "value": "MSAZR0063P" + }, + { + "name": "Msazr0064P", + "value": "MSAZR0064P" + }, + { + "name": "Msazr0029P", + "value": "MSAZR0029P" + }, + { + "name": "Msazr0022P", + "value": "MSAZR0022P" + }, + { + "name": "Msazr0023P", + "value": "MSAZR0023P" + }, + { + "name": "Msazr0148P", + "value": "MSAZR0148P" + }, + { + "name": "Msazr0025P", + "value": "MSAZR0025P" + }, + { + "name": "Msazr0036P", + "value": "MSAZR0036P" + }, + { + "name": "Msazr0120P", + "value": "MSAZR0120P" + }, + { + "name": "Msazr0121P", + "value": "MSAZR0121P" + }, + { + "name": "Msazr0122P", + "value": "MSAZR0122P" + }, + { + "name": "Msazr0123P", + "value": "MSAZR0123P" + }, + { + "name": "Msazr0124P", + "value": "MSAZR0124P" + }, + { + "name": "Msazr0125P", + "value": "MSAZR0125P" + }, + { + "name": "Msazr0126P", + "value": "MSAZR0126P" + }, + { + "name": "Msazr0127P", + "value": "MSAZR0127P" + }, + { + "name": "Msazr0128P", + "value": "MSAZR0128P" + }, + { + "name": "Msazr0129P", + "value": "MSAZR0129P" + }, + { + "name": "Msazr0130P", + "value": "MSAZR0130P" + }, + { + "name": "Msazr0111P", + "value": "MSAZR0111P" + }, + { + "name": "Msazr0144P", + "value": "MSAZR0144P" + }, + { + "name": "Msazr0149P", + "value": "MSAZR0149P" + }, + { + "name": "Msmcazr0044P", + "value": "MSMCAZR0044P" + }, + { + "name": "Msmcazr0059P", + "value": "MSMCAZR0059P" + }, + { + "name": "Msmcazr0060P", + "value": "MSMCAZR0060P" + }, + { + "name": "Msmcazr0063P", + "value": "MSMCAZR0063P" + }, + { + "name": "Msmcazr0120P", + "value": "MSMCAZR0120P" + }, + { + "name": "Msmcazr0121P", + "value": "MSMCAZR0121P" + }, + { + "name": "Msmcazr0125P", + "value": "MSMCAZR0125P" + }, + { + "name": "Msmcazr0128P", + "value": "MSMCAZR0128P" + }, + { + "name": "Msazrde0003P", + "value": "MSAZRDE0003P" + }, + { + "name": "Msazrde0044P", + "value": "MSAZRDE0044P" + }, + { + "name": "Msazrusgov0003P", + "value": "MSAZRUSGOV0003P" + }, + { + "name": "EA", + "value": "EA" + }, + { + "name": "Msazr0243P", + "value": "MSAZR0243P" + }, + { + "name": "SavingsPlan1Year", + "value": "SavingsPlan1Year" + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year" + } + ] + } + }, + "AzurePaasSummary": { + "type": "object", + "description": "Shows the PaaS Azure summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Number of Sql instances.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable Sql instances.", + "readOnly": true + }, + "totalWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web applications.", + "readOnly": true + }, + "suitableWebApps": { + "type": "integer", + "format": "int32", + "description": "Suitable web applications.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Memory Utilization.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "float", + "description": "Storage Utilization.", + "readOnly": true + }, + "estimatedCostByTarget": { + "$ref": "#/definitions/EstimatedCostByTarget", + "description": "Shows the estimated cost by target.", + "readOnly": true + }, + "estimatedSqlServerLicensingCost": { + "type": "number", + "format": "float", + "description": "estimated SQL Server licensing cost.", + "readOnly": true + }, + "azureSqlSummary": { + "$ref": "#/definitions/AzureSqlSummary", + "description": "Shows the Azure SQL details.", + "readOnly": true + }, + "azureAppServiceSummary": { + "$ref": "#/definitions/AzureAppServiceSummary", + "description": "Shows Azure App Service summary.", + "readOnly": true + }, + "azureAppServiceContainerSummary": { + "$ref": "#/definitions/AzureAppServiceContainerSummary", + "description": "Shows Azure App Service Container summary.", + "readOnly": true + }, + "azureKubernetesServiceSummary": { + "$ref": "#/definitions/AzureKubernetesServiceSummary", + "description": "Shows Azure Kubernetes Service summary.", + "readOnly": true + }, + "totalAzurePaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzurePricingTier": { + "type": "string", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "AzurePricingTier", + "modelAsString": true + } + }, + "AzureQuorumWitnessDTO": { + "type": "object", + "description": "Quorum Witness.", + "properties": { + "quorumWitnessType": { + "$ref": "#/definitions/AzureQuorumWitnessDTOQuorumWitnessType", + "description": "Gets quorum witness type.", + "readOnly": true + } + } + }, + "AzureQuorumWitnessDTOQuorumWitnessType": { + "type": "string", + "enum": [ + "Unknown", + "Cloud", + "Disk" + ], + "x-ms-enum": { + "name": "AzureQuorumWitnessDTOQuorumWitnessType", + "modelAsString": true + } + }, + "AzureReservedInstance": { + "type": "string", + "enum": [ + "None", + "RI1Year", + "RI3Year" + ], + "x-ms-enum": { + "name": "AzureReservedInstance", + "modelAsString": true + } + }, + "AzureResourceProperties": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AzureResourceProperties2": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState2", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AzureSecurityOfferingType": { + "type": "string", + "enum": [ + "NO", + "MDC" + ], + "x-ms-enum": { + "name": "AzureSecurityOfferingType", + "modelAsString": true + } + }, + "AzureSettings": { + "type": "object", + "description": "Azure settings for a business case.", + "properties": { + "targetLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets azure Discount percentage.", + "minimum": 0, + "maximum": 100 + }, + "currency": { + "$ref": "#/definitions/BusinessCaseCurrency", + "description": "Business case Currency.", + "default": "USD" + }, + "businessCaseType": { + "$ref": "#/definitions/MigrationStrategy", + "description": "Migration Strategy.", + "default": "OptimizeForCost" + }, + "workloadDiscoverySource": { + "$ref": "#/definitions/DiscoverySource", + "description": "Workload discovery source.", + "default": "Appliance" + }, + "performanceDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets start time to use for performance." + }, + "performanceDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets end time to use for performance." + }, + "comfortFactor": { + "type": "number", + "format": "float", + "description": "Gets comfort factor.", + "default": 1 + }, + "performanceUtilizationPercentile": { + "type": "number", + "format": "float", + "description": "Gets utilization percentile for performance.", + "default": 95, + "minimum": 0, + "maximum": 100 + }, + "perYearMigrationCompletionPercentage": { + "type": "object", + "description": "Gets migration completion percentage per year.", + "additionalProperties": { + "format": "float", + "type": "number" + } + }, + "infrastructureGrowthRate": { + "type": "number", + "format": "float", + "description": "Gets infrastructure growth rate.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "wacc": { + "type": "number", + "format": "float", + "description": "Gets wACC percentage.", + "minimum": 0, + "maximum": 100 + }, + "networkCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets network cost percentage.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "iaasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets IaaS labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "paasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets PaaS labour cost percentage.", + "default": 60, + "minimum": 0, + "maximum": 100 + }, + "avsLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets Avs labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "savingsOption": { + "$ref": "#/definitions/SavingsOption", + "description": "Gets the business case savings option type.", + "default": "RI3Year" + } + }, + "required": [ + "targetLocation", + "currency" + ] + }, + "AzureSqlDataBaseType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleDatabase", + "ElasticPool" + ], + "x-ms-enum": { + "name": "AzureSqlDataBaseType", + "modelAsString": true + } + }, + "AzureSqlIaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL IAAS SKU.", + "properties": { + "virtualMachineSize": { + "$ref": "#/definitions/AzureVirtualMachineSkuDTO", + "description": "Gets the The Azure Compute Virtual Machine.", + "readOnly": true + }, + "dataDiskSizes": { + "type": "array", + "description": "Gets the The list of data disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "logDiskSizes": { + "type": "array", + "description": "Gets the The list of log disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlInstanceType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleInstance", + "InstancePools" + ], + "x-ms-enum": { + "name": "AzureSqlInstanceType", + "modelAsString": true + } + }, + "AzureSqlPaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL PAAS SKU.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets the service tier.", + "readOnly": true + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets the compute tier.", + "readOnly": true + }, + "azureSqlHardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets the hardware generation.", + "readOnly": true + }, + "storageMaxSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the storage maximum size in megabytes.", + "readOnly": true + }, + "predictedDataSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted data size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "predictedLogSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted log size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the number of cores.", + "readOnly": true + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlPurchaseModel": { + "type": "string", + "enum": [ + "Unknown", + "VCore", + "DTU" + ], + "x-ms-enum": { + "name": "AzureSqlPurchaseModel", + "modelAsString": true + } + }, + "AzureSqlServiceTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "GeneralPurpose", + "BusinessCritical", + "HyperScale" + ], + "x-ms-enum": { + "name": "AzureSqlServiceTier", + "modelAsString": true + } + }, + "AzureSqlSummary": { + "type": "object", + "description": "Shows the Azure SQL details.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommended offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTier": { + "type": "array", + "description": "Distribution by service tiers, retaining just to support older Business cases.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlMi": { + "type": "array", + "description": "Distribution by service tiers for SQL MI.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlDb": { + "type": "array", + "description": "Distribution by service tiers for SQL DB.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureStorageRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LocallyRedundant", + "ZoneRedundant", + "GeoRedundant", + "ReadAccessGeoRedundant" + ], + "x-ms-enum": { + "name": "AzureStorageRedundancy", + "modelAsString": true + } + }, + "AzureVirtualMachineSkuDTO": { + "type": "object", + "description": "Azure Virtual Machine SKU.", + "properties": { + "azureVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets the Virtual Machine Family, for example : standardMSFamily.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the Compute Size in vCores.", + "readOnly": true + }, + "azureSkuName": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets the Virtual Machine SKU name,: E.g. : Standard_F16s.", + "readOnly": true + }, + "availableCores": { + "type": "integer", + "format": "int32", + "description": "Gets the Available vCores. This can be less than the vCores in the Constrained\nvCPU VM Sizes.", + "readOnly": true + }, + "maxNetworkInterfaces": { + "type": "integer", + "format": "int32", + "description": "Gets the Max network interfaces.", + "readOnly": true + } + } + }, + "AzureVmCategory": { + "type": "string", + "description": "Azure VM Category.", + "enum": [ + "All", + "ComputeOptimized", + "GeneralPurpose", + "GpuOptimized", + "HighPerformanceCompute", + "MemoryOptimized", + "StorageOptimized", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureVmCategory", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "Indicates All categories of VM." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute Optimized." + }, + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General Purpose." + }, + { + "name": "GpuOptimized", + "value": "GpuOptimized", + "description": "GPU Optimized." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "High Performance Compute." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory Optimized." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage Optimized." + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "Isolated VM." + } + ] + } + }, + "AzureVmFamily": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0_A4", + "Standard_A0_A7", + "Standard_A8_A11", + "Av2_series", + "D_series", + "Dv2_series", + "DS_series", + "DSv2_series", + "F_series", + "Fs_series", + "G_series", + "GS_series", + "H_series", + "Ls_series", + "Dsv3_series", + "Dv3_series", + "Fsv2_series", + "Ev3_series", + "Esv3_series", + "M_series", + "DC_Series", + "Lsv2_series", + "Ev4_series", + "Esv4_series", + "Edv4_series", + "Edsv4_series", + "Dv4_series", + "Dsv4_series", + "Ddv4_series", + "Ddsv4_series", + "Easv4_series", + "Dasv4_series", + "Mv2_series", + "Eav4_series", + "Dav4_series", + "Msv2_series", + "Mdsv2_series", + "Dv5_series", + "Dsv5_series", + "Ddv5_series", + "Ddsv5_series", + "Dasv5_series", + "Dadsv5_series", + "Ev5_series", + "Esv5_series", + "Edv5_series", + "Edsv5_series", + "Easv5_series", + "Eadsv5_series", + "Ebsv5_series", + "Ebdsv5_series" + ], + "x-ms-enum": { + "name": "AzureVmFamily", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0A4", + "value": "Basic_A0_A4" + }, + { + "name": "StandardA0A7", + "value": "Standard_A0_A7" + }, + { + "name": "StandardA8A11", + "value": "Standard_A8_A11" + }, + { + "name": "Av2Series", + "value": "Av2_series" + }, + { + "name": "DSeries", + "value": "D_series" + }, + { + "name": "Dv2Series", + "value": "Dv2_series" + }, + { + "name": "DSSeries", + "value": "DS_series" + }, + { + "name": "DSv2Series", + "value": "DSv2_series" + }, + { + "name": "FSeries", + "value": "F_series" + }, + { + "name": "FsSeries", + "value": "Fs_series" + }, + { + "name": "GSeries", + "value": "G_series" + }, + { + "name": "GSSeries", + "value": "GS_series" + }, + { + "name": "HSeries", + "value": "H_series" + }, + { + "name": "LsSeries", + "value": "Ls_series" + }, + { + "name": "Dsv3Series", + "value": "Dsv3_series" + }, + { + "name": "Dv3Series", + "value": "Dv3_series" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "Ev3Series", + "value": "Ev3_series" + }, + { + "name": "Esv3Series", + "value": "Esv3_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_Series" + }, + { + "name": "Lsv2Series", + "value": "Lsv2_series" + }, + { + "name": "Ev4Series", + "value": "Ev4_series" + }, + { + "name": "Esv4Series", + "value": "Esv4_series" + }, + { + "name": "Edv4Series", + "value": "Edv4_series" + }, + { + "name": "Edsv4Series", + "value": "Edsv4_series" + }, + { + "name": "Dv4Series", + "value": "Dv4_series" + }, + { + "name": "Dsv4Series", + "value": "Dsv4_series" + }, + { + "name": "Ddv4Series", + "value": "Ddv4_series" + }, + { + "name": "Ddsv4Series", + "value": "Ddsv4_series" + }, + { + "name": "Easv4Series", + "value": "Easv4_series" + }, + { + "name": "Dasv4Series", + "value": "Dasv4_series" + }, + { + "name": "Mv2Series", + "value": "Mv2_series" + }, + { + "name": "Eav4Series", + "value": "Eav4_series" + }, + { + "name": "Dav4Series", + "value": "Dav4_series" + }, + { + "name": "Msv2Series", + "value": "Msv2_series" + }, + { + "name": "Mdsv2Series", + "value": "Mdsv2_series" + }, + { + "name": "Dv5Series", + "value": "Dv5_series" + }, + { + "name": "Dsv5Series", + "value": "Dsv5_series" + }, + { + "name": "Ddv5Series", + "value": "Ddv5_series" + }, + { + "name": "Ddsv5Series", + "value": "Ddsv5_series" + }, + { + "name": "Dasv5Series", + "value": "Dasv5_series" + }, + { + "name": "Dadsv5Series", + "value": "Dadsv5_series" + }, + { + "name": "Ev5Series", + "value": "Ev5_series" + }, + { + "name": "Esv5Series", + "value": "Esv5_series" + }, + { + "name": "Edv5Series", + "value": "Edv5_series" + }, + { + "name": "Edsv5Series", + "value": "Edsv5_series" + }, + { + "name": "Easv5Series", + "value": "Easv5_series" + }, + { + "name": "Eadsv5Series", + "value": "Eadsv5_series" + }, + { + "name": "Ebsv5Series", + "value": "Ebsv5_series" + }, + { + "name": "Ebdsv5Series", + "value": "Ebdsv5_series" + } + ] + } + }, + "AzureVmSize": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_DC2s", + "Standard_DC4s", + "Standard_E20_v3", + "Standard_E20s_v3", + "Standard_E64i_v3", + "Standard_E64is_v3", + "Standard_M8ms", + "Standard_M16ms", + "Standard_M32ls", + "Standard_M32ms", + "Standard_M32ts", + "Standard_M64", + "Standard_M64ls", + "Standard_M64m", + "Standard_M128", + "Standard_M128m", + "Standard_L8s_v2", + "Standard_L16s_v2", + "Standard_L32s_v2", + "Standard_L48s_v2", + "Standard_L64s_v2", + "Standard_L80s_v2", + "Standard_D2_v4", + "Standard_D4_v4", + "Standard_D8_v4", + "Standard_D16_v4", + "Standard_D32_v4", + "Standard_D48_v4", + "Standard_D64_v4", + "Standard_D2s_v4", + "Standard_D4s_v4", + "Standard_D8s_v4", + "Standard_D16s_v4", + "Standard_D32s_v4", + "Standard_D48s_v4", + "Standard_D64s_v4", + "Standard_D2d_v4", + "Standard_D4d_v4", + "Standard_D8d_v4", + "Standard_D16d_v4", + "Standard_D32d_v4", + "Standard_D48d_v4", + "Standard_D64d_v4", + "Standard_D2ds_v4", + "Standard_D4ds_v4", + "Standard_D8ds_v4", + "Standard_D16ds_v4", + "Standard_D32ds_v4", + "Standard_D48ds_v4", + "Standard_D64ds_v4", + "Standard_E2_v4", + "Standard_E4_v4", + "Standard_E8_v4", + "Standard_E16_v4", + "Standard_E20_v4", + "Standard_E32_v4", + "Standard_E48_v4", + "Standard_E64_v4", + "Standard_E2s_v4", + "Standard_E4s_v4", + "Standard_E8s_v4", + "Standard_E16s_v4", + "Standard_E20s_v4", + "Standard_E32s_v4", + "Standard_E48s_v4", + "Standard_E64s_v4", + "Standard_E2d_v4", + "Standard_E4d_v4", + "Standard_E8d_v4", + "Standard_E16d_v4", + "Standard_E20d_v4", + "Standard_E32d_v4", + "Standard_E48d_v4", + "Standard_E64d_v4", + "Standard_E2ds_v4", + "Standard_E4ds_v4", + "Standard_E8ds_v4", + "Standard_E16ds_v4", + "Standard_E20ds_v4", + "Standard_E32ds_v4", + "Standard_E48ds_v4", + "Standard_E64ds_v4", + "Standard_E2as_v4", + "Standard_E4as_v4", + "Standard_E8as_v4", + "Standard_E16as_v4", + "Standard_E20as_v4", + "Standard_E32as_v4", + "Standard_E48as_v4", + "Standard_E64as_v4", + "Standard_E96as_v4", + "Standard_D2as_v4", + "Standard_D4as_v4", + "Standard_D8as_v4", + "Standard_D16as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D64as_v4", + "Standard_D96as_v4", + "Standard_M208ms_v2", + "Standard_M208s_v2", + "Standard_M416ms_v2", + "Standard_M416s_v2", + "Standard_F48s_v2", + "Standard_E48_v3", + "Standard_E48s_v3", + "Standard_E80is_v4", + "Standard_E80ids_v4", + "Standard_E2a_v4", + "Standard_E4a_v4", + "Standard_E8a_v4", + "Standard_E16a_v4", + "Standard_E20a_v4", + "Standard_E32a_v4", + "Standard_E48a_v4", + "Standard_E64a_v4", + "Standard_E96a_v4", + "Standard_D2a_v4", + "Standard_D4a_v4", + "Standard_D8a_v4", + "Standard_D16a_v4", + "Standard_D32a_v4", + "Standard_D48a_v4", + "Standard_D64a_v4", + "Standard_D96a_v4", + "Standard_M32ms_v2", + "Standard_M64s_v2", + "Standard_M64ms_v2", + "Standard_M128s_v2", + "Standard_M128ms_v2", + "Standard_M192is_v2", + "Standard_M192ims_v2", + "Standard_M32dms_v2", + "Standard_M64ds_v2", + "Standard_M64dms_v2", + "Standard_M128ds_v2", + "Standard_M128dms_v2", + "Standard_M192ids_v2", + "Standard_M192idms_v2", + "Standard_D2_v5", + "Standard_D4_v5", + "Standard_D8_v5", + "Standard_D16_v5", + "Standard_D32_v5", + "Standard_D48_v5", + "Standard_D64_v5", + "Standard_D96_v5", + "Standard_D2s_v5", + "Standard_D4s_v5", + "Standard_D8s_v5", + "Standard_D16s_v5", + "Standard_D32s_v5", + "Standard_D48s_v5", + "Standard_D64s_v5", + "Standard_D96s_v5", + "Standard_D2d_v5", + "Standard_D4d_v5", + "Standard_D8d_v5", + "Standard_D16d_v5", + "Standard_D32d_v5", + "Standard_D48d_v5", + "Standard_D64d_v5", + "Standard_D96d_v5", + "Standard_D2ds_v5", + "Standard_D4ds_v5", + "Standard_D8ds_v5", + "Standard_D16ds_v5", + "Standard_D32ds_v5", + "Standard_D48ds_v5", + "Standard_D64ds_v5", + "Standard_D96ds_v5", + "Standard_D2as_v5", + "Standard_D4as_v5", + "Standard_D8as_v5", + "Standard_D16as_v5", + "Standard_D32as_v5", + "Standard_D48as_v5", + "Standard_D64as_v5", + "Standard_D96as_v5", + "Standard_D2ads_v5", + "Standard_D4ads_v5", + "Standard_D8ads_v5", + "Standard_D16ads_v5", + "Standard_D32ads_v5", + "Standard_D48ads_v5", + "Standard_D64ads_v5", + "Standard_D96ads_v5", + "Standard_E2_v5", + "Standard_E4_v5", + "Standard_E8_v5", + "Standard_E16_v5", + "Standard_E20_v5", + "Standard_E32_v5", + "Standard_E48_v5", + "Standard_E64_v5", + "Standard_E96_v5", + "Standard_E104i_v5", + "Standard_E2s_v5", + "Standard_E4s_v5", + "Standard_E8s_v5", + "Standard_E16s_v5", + "Standard_E20s_v5", + "Standard_E32s_v5", + "Standard_E48s_v5", + "Standard_E64s_v5", + "Standard_E96s_v5", + "Standard_E104is_v5", + "Standard_E2d_v5", + "Standard_E4d_v5", + "Standard_E8d_v5", + "Standard_E16d_v5", + "Standard_E20d_v5", + "Standard_E32d_v5", + "Standard_E48d_v5", + "Standard_E64d_v5", + "Standard_E96d_v5", + "Standard_E104id_v5", + "Standard_E2ds_v5", + "Standard_E4ds_v5", + "Standard_E8ds_v5", + "Standard_E16ds_v5", + "Standard_E20ds_v5", + "Standard_E32ds_v5", + "Standard_E48ds_v5", + "Standard_E64ds_v5", + "Standard_E96ds_v5", + "Standard_E104ids_v5", + "Standard_E2as_v5", + "Standard_E4as_v5", + "Standard_E8as_v5", + "Standard_E16as_v5", + "Standard_E20as_v5", + "Standard_E32as_v5", + "Standard_E48as_v5", + "Standard_E64as_v5", + "Standard_E96as_v5", + "Standard_E2ads_v5", + "Standard_E4ads_v5", + "Standard_E8ads_v5", + "Standard_E16ads_v5", + "Standard_E20ads_v5", + "Standard_E32ads_v5", + "Standard_E48ads_v5", + "Standard_E64ads_v5", + "Standard_E96ads_v5", + "Standard_M8_2ms", + "Standard_M8_4ms", + "Standard_M16_4ms", + "Standard_M16_8ms", + "Standard_M32_8ms", + "Standard_M32_16ms", + "Standard_M64_32ms", + "Standard_M64_16ms", + "Standard_M128_64ms", + "Standard_M128_32ms", + "Standard_E4_2s_v3", + "Standard_E8_4s_v3", + "Standard_E8_2s_v3", + "Standard_E16_8s_v3", + "Standard_E16_4s_v3", + "Standard_E32_16s_v3", + "Standard_E32_8s_v3", + "Standard_E64_32s_v3", + "Standard_E64_16s_v3", + "Standard_E4_2s_v4", + "Standard_E8_4s_v4", + "Standard_E8_2s_v4", + "Standard_E16_8s_v4", + "Standard_E16_4s_v4", + "Standard_E32_16s_v4", + "Standard_E32_8s_v4", + "Standard_E64_32s_v4", + "Standard_E64_16s_v4", + "Standard_E4_2ds_v4", + "Standard_E8_4ds_v4", + "Standard_E8_2ds_v4", + "Standard_E16_8ds_v4", + "Standard_E16_4ds_v4", + "Standard_E32_16ds_v4", + "Standard_E32_8ds_v4", + "Standard_E64_32ds_v4", + "Standard_E64_16ds_v4", + "Standard_E4_2as_v4", + "Standard_E8_4as_v4", + "Standard_E8_2as_v4", + "Standard_E16_8as_v4", + "Standard_E16_4as_v4", + "Standard_E32_16as_v4", + "Standard_E32_8as_v4", + "Standard_E64_32as_v4", + "Standard_E64_16as_v4", + "Standard_E96_48as_v4", + "Standard_E96_24as_v4", + "Standard_E4_2ads_v5", + "Standard_E8_4ads_v5", + "Standard_E8_2ads_v5", + "Standard_E16_8ads_v5", + "Standard_E16_4ads_v5", + "Standard_E32_16ads_v5", + "Standard_E32_8ads_v5", + "Standard_E64_32ads_v5", + "Standard_E64_16ads_v5", + "Standard_E96_48ads_v5", + "Standard_E96_24ads_v5", + "Standard_E4_2s_v5", + "Standard_E8_4s_v5", + "Standard_E8_2s_v5", + "Standard_E16_8s_v5", + "Standard_E16_4s_v5", + "Standard_E32_16s_v5", + "Standard_E32_8s_v5", + "Standard_E64_32s_v5", + "Standard_E64_16s_v5", + "Standard_E96_48s_v5", + "Standard_E96_24s_v5", + "Standard_E4_2ds_v5", + "Standard_E8_4ds_v5", + "Standard_E8_2ds_v5", + "Standard_E16_8ds_v5", + "Standard_E16_4ds_v5", + "Standard_E32_16ds_v5", + "Standard_E32_8ds_v5", + "Standard_E64_32ds_v5", + "Standard_E64_16ds_v5", + "Standard_E96_48ds_v5", + "Standard_E96_24ds_v5", + "Standard_E4_2as_v5", + "Standard_E8_4as_v5", + "Standard_E8_2as_v5", + "Standard_E16_8as_v5", + "Standard_E16_4as_v5", + "Standard_E32_16as_v5", + "Standard_E32_8as_v5", + "Standard_E64_32as_v5", + "Standard_E64_16as_v5", + "Standard_E96_48as_v5", + "Standard_E96_24as_v5", + "Standard_GS4_8", + "Standard_GS4_4", + "Standard_GS5_16", + "Standard_GS5_8", + "Standard_DS11_1_v2", + "Standard_DS12_2_v2", + "Standard_DS12_1_v2", + "Standard_DS13_4_v2", + "Standard_DS13_2_v2", + "Standard_DS14_8_v2", + "Standard_DS14_4_v2", + "Standard_M416_208s_v2", + "Standard_M416_208ms_v2", + "Standard_E2bs_v5", + "Standard_E4bs_v5", + "Standard_E8bs_v5", + "Standard_E16bs_v5", + "Standard_E32bs_v5", + "Standard_E48bs_v5", + "Standard_E64bs_v5", + "Standard_E2bds_v5", + "Standard_E4bds_v5", + "Standard_E8bds_v5", + "Standard_E16bds_v5", + "Standard_E32bds_v5", + "Standard_E48bds_v5", + "Standard_E64bds_v5" + ], + "x-ms-enum": { + "name": "AzureVmSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0", + "value": "Basic_A0" + }, + { + "name": "BasicA1", + "value": "Basic_A1" + }, + { + "name": "BasicA2", + "value": "Basic_A2" + }, + { + "name": "BasicA3", + "value": "Basic_A3" + }, + { + "name": "BasicA4", + "value": "Basic_A4" + }, + { + "name": "StandardA0", + "value": "Standard_A0" + }, + { + "name": "StandardA1", + "value": "Standard_A1" + }, + { + "name": "StandardA2", + "value": "Standard_A2" + }, + { + "name": "StandardA3", + "value": "Standard_A3" + }, + { + "name": "StandardA4", + "value": "Standard_A4" + }, + { + "name": "StandardA5", + "value": "Standard_A5" + }, + { + "name": "StandardA6", + "value": "Standard_A6" + }, + { + "name": "StandardA7", + "value": "Standard_A7" + }, + { + "name": "StandardA8", + "value": "Standard_A8" + }, + { + "name": "StandardA9", + "value": "Standard_A9" + }, + { + "name": "StandardA10", + "value": "Standard_A10" + }, + { + "name": "StandardA11", + "value": "Standard_A11" + }, + { + "name": "StandardA1V2", + "value": "Standard_A1_v2" + }, + { + "name": "StandardA2V2", + "value": "Standard_A2_v2" + }, + { + "name": "StandardA4V2", + "value": "Standard_A4_v2" + }, + { + "name": "StandardA8V2", + "value": "Standard_A8_v2" + }, + { + "name": "StandardA2MV2", + "value": "Standard_A2m_v2" + }, + { + "name": "StandardA4MV2", + "value": "Standard_A4m_v2" + }, + { + "name": "StandardA8MV2", + "value": "Standard_A8m_v2" + }, + { + "name": "StandardD1", + "value": "Standard_D1" + }, + { + "name": "StandardD2", + "value": "Standard_D2" + }, + { + "name": "StandardD3", + "value": "Standard_D3" + }, + { + "name": "StandardD4", + "value": "Standard_D4" + }, + { + "name": "StandardD11", + "value": "Standard_D11" + }, + { + "name": "StandardD12", + "value": "Standard_D12" + }, + { + "name": "StandardD13", + "value": "Standard_D13" + }, + { + "name": "StandardD14", + "value": "Standard_D14" + }, + { + "name": "StandardD1V2", + "value": "Standard_D1_v2" + }, + { + "name": "StandardD2V2", + "value": "Standard_D2_v2" + }, + { + "name": "StandardD3V2", + "value": "Standard_D3_v2" + }, + { + "name": "StandardD4V2", + "value": "Standard_D4_v2" + }, + { + "name": "StandardD5V2", + "value": "Standard_D5_v2" + }, + { + "name": "StandardD11V2", + "value": "Standard_D11_v2" + }, + { + "name": "StandardD12V2", + "value": "Standard_D12_v2" + }, + { + "name": "StandardD13V2", + "value": "Standard_D13_v2" + }, + { + "name": "StandardD14V2", + "value": "Standard_D14_v2" + }, + { + "name": "StandardD15V2", + "value": "Standard_D15_v2" + }, + { + "name": "StandardDS1", + "value": "Standard_DS1" + }, + { + "name": "StandardDS2", + "value": "Standard_DS2" + }, + { + "name": "StandardDS3", + "value": "Standard_DS3" + }, + { + "name": "StandardDS4", + "value": "Standard_DS4" + }, + { + "name": "StandardDS11", + "value": "Standard_DS11" + }, + { + "name": "StandardDS12", + "value": "Standard_DS12" + }, + { + "name": "StandardDS13", + "value": "Standard_DS13" + }, + { + "name": "StandardDS14", + "value": "Standard_DS14" + }, + { + "name": "StandardDS1V2", + "value": "Standard_DS1_v2" + }, + { + "name": "StandardDS2V2", + "value": "Standard_DS2_v2" + }, + { + "name": "StandardDS3V2", + "value": "Standard_DS3_v2" + }, + { + "name": "StandardDS4V2", + "value": "Standard_DS4_v2" + }, + { + "name": "StandardDS5V2", + "value": "Standard_DS5_v2" + }, + { + "name": "StandardDS11V2", + "value": "Standard_DS11_v2" + }, + { + "name": "StandardDS12V2", + "value": "Standard_DS12_v2" + }, + { + "name": "StandardDS13V2", + "value": "Standard_DS13_v2" + }, + { + "name": "StandardDS14V2", + "value": "Standard_DS14_v2" + }, + { + "name": "StandardDS15V2", + "value": "Standard_DS15_v2" + }, + { + "name": "StandardF1", + "value": "Standard_F1" + }, + { + "name": "StandardF2", + "value": "Standard_F2" + }, + { + "name": "StandardF4", + "value": "Standard_F4" + }, + { + "name": "StandardF8", + "value": "Standard_F8" + }, + { + "name": "StandardF16", + "value": "Standard_F16" + }, + { + "name": "StandardF1S", + "value": "Standard_F1s" + }, + { + "name": "StandardF2S", + "value": "Standard_F2s" + }, + { + "name": "StandardF4S", + "value": "Standard_F4s" + }, + { + "name": "StandardF8S", + "value": "Standard_F8s" + }, + { + "name": "StandardF16S", + "value": "Standard_F16s" + }, + { + "name": "StandardG1", + "value": "Standard_G1" + }, + { + "name": "StandardG2", + "value": "Standard_G2" + }, + { + "name": "StandardG3", + "value": "Standard_G3" + }, + { + "name": "StandardG4", + "value": "Standard_G4" + }, + { + "name": "StandardG5", + "value": "Standard_G5" + }, + { + "name": "StandardGS1", + "value": "Standard_GS1" + }, + { + "name": "StandardGS2", + "value": "Standard_GS2" + }, + { + "name": "StandardGS3", + "value": "Standard_GS3" + }, + { + "name": "StandardGS4", + "value": "Standard_GS4" + }, + { + "name": "StandardGS5", + "value": "Standard_GS5" + }, + { + "name": "StandardH8", + "value": "Standard_H8" + }, + { + "name": "StandardH16", + "value": "Standard_H16" + }, + { + "name": "StandardH8M", + "value": "Standard_H8m" + }, + { + "name": "StandardH16M", + "value": "Standard_H16m" + }, + { + "name": "StandardH16R", + "value": "Standard_H16r" + }, + { + "name": "StandardH16Mr", + "value": "Standard_H16mr" + }, + { + "name": "StandardL4S", + "value": "Standard_L4s" + }, + { + "name": "StandardL8S", + "value": "Standard_L8s" + }, + { + "name": "StandardL16S", + "value": "Standard_L16s" + }, + { + "name": "StandardL32S", + "value": "Standard_L32s" + }, + { + "name": "StandardD2SV3", + "value": "Standard_D2s_v3" + }, + { + "name": "StandardD4SV3", + "value": "Standard_D4s_v3" + }, + { + "name": "StandardD8SV3", + "value": "Standard_D8s_v3" + }, + { + "name": "StandardD16SV3", + "value": "Standard_D16s_v3" + }, + { + "name": "StandardD32SV3", + "value": "Standard_D32s_v3" + }, + { + "name": "StandardD64SV3", + "value": "Standard_D64s_v3" + }, + { + "name": "StandardD2V3", + "value": "Standard_D2_v3" + }, + { + "name": "StandardD4V3", + "value": "Standard_D4_v3" + }, + { + "name": "StandardD8V3", + "value": "Standard_D8_v3" + }, + { + "name": "StandardD16V3", + "value": "Standard_D16_v3" + }, + { + "name": "StandardD32V3", + "value": "Standard_D32_v3" + }, + { + "name": "StandardD64V3", + "value": "Standard_D64_v3" + }, + { + "name": "StandardF2SV2", + "value": "Standard_F2s_v2" + }, + { + "name": "StandardF4SV2", + "value": "Standard_F4s_v2" + }, + { + "name": "StandardF8SV2", + "value": "Standard_F8s_v2" + }, + { + "name": "StandardF16SV2", + "value": "Standard_F16s_v2" + }, + { + "name": "StandardF32SV2", + "value": "Standard_F32s_v2" + }, + { + "name": "StandardF64SV2", + "value": "Standard_F64s_v2" + }, + { + "name": "StandardF72SV2", + "value": "Standard_F72s_v2" + }, + { + "name": "StandardE2V3", + "value": "Standard_E2_v3" + }, + { + "name": "StandardE4V3", + "value": "Standard_E4_v3" + }, + { + "name": "StandardE8V3", + "value": "Standard_E8_v3" + }, + { + "name": "StandardE16V3", + "value": "Standard_E16_v3" + }, + { + "name": "StandardE32V3", + "value": "Standard_E32_v3" + }, + { + "name": "StandardE64V3", + "value": "Standard_E64_v3" + }, + { + "name": "StandardE2SV3", + "value": "Standard_E2s_v3" + }, + { + "name": "StandardE4SV3", + "value": "Standard_E4s_v3" + }, + { + "name": "StandardE8SV3", + "value": "Standard_E8s_v3" + }, + { + "name": "StandardE16SV3", + "value": "Standard_E16s_v3" + }, + { + "name": "StandardE32SV3", + "value": "Standard_E32s_v3" + }, + { + "name": "StandardE64SV3", + "value": "Standard_E64s_v3" + }, + { + "name": "StandardM64S", + "value": "Standard_M64s" + }, + { + "name": "StandardM64Ms", + "value": "Standard_M64ms" + }, + { + "name": "StandardM128S", + "value": "Standard_M128s" + }, + { + "name": "StandardM128Ms", + "value": "Standard_M128ms" + }, + { + "name": "StandardDC2S", + "value": "Standard_DC2s" + }, + { + "name": "StandardDC4S", + "value": "Standard_DC4s" + }, + { + "name": "StandardE20V3", + "value": "Standard_E20_v3" + }, + { + "name": "StandardE20SV3", + "value": "Standard_E20s_v3" + }, + { + "name": "StandardE64IV3", + "value": "Standard_E64i_v3" + }, + { + "name": "StandardE64IsV3", + "value": "Standard_E64is_v3" + }, + { + "name": "StandardM8Ms", + "value": "Standard_M8ms" + }, + { + "name": "StandardM16Ms", + "value": "Standard_M16ms" + }, + { + "name": "StandardM32Ls", + "value": "Standard_M32ls" + }, + { + "name": "StandardM32Ms", + "value": "Standard_M32ms" + }, + { + "name": "StandardM32Ts", + "value": "Standard_M32ts" + }, + { + "name": "StandardM64", + "value": "Standard_M64" + }, + { + "name": "StandardM64Ls", + "value": "Standard_M64ls" + }, + { + "name": "StandardM64M", + "value": "Standard_M64m" + }, + { + "name": "StandardM128", + "value": "Standard_M128" + }, + { + "name": "StandardM128M", + "value": "Standard_M128m" + }, + { + "name": "StandardL8SV2", + "value": "Standard_L8s_v2" + }, + { + "name": "StandardL16SV2", + "value": "Standard_L16s_v2" + }, + { + "name": "StandardL32SV2", + "value": "Standard_L32s_v2" + }, + { + "name": "StandardL48SV2", + "value": "Standard_L48s_v2" + }, + { + "name": "StandardL64SV2", + "value": "Standard_L64s_v2" + }, + { + "name": "StandardL80SV2", + "value": "Standard_L80s_v2" + }, + { + "name": "StandardD2V4", + "value": "Standard_D2_v4" + }, + { + "name": "StandardD4V4", + "value": "Standard_D4_v4" + }, + { + "name": "StandardD8V4", + "value": "Standard_D8_v4" + }, + { + "name": "StandardD16V4", + "value": "Standard_D16_v4" + }, + { + "name": "StandardD32V4", + "value": "Standard_D32_v4" + }, + { + "name": "StandardD48V4", + "value": "Standard_D48_v4" + }, + { + "name": "StandardD64V4", + "value": "Standard_D64_v4" + }, + { + "name": "StandardD2SV4", + "value": "Standard_D2s_v4" + }, + { + "name": "StandardD4SV4", + "value": "Standard_D4s_v4" + }, + { + "name": "StandardD8SV4", + "value": "Standard_D8s_v4" + }, + { + "name": "StandardD16SV4", + "value": "Standard_D16s_v4" + }, + { + "name": "StandardD32SV4", + "value": "Standard_D32s_v4" + }, + { + "name": "StandardD48SV4", + "value": "Standard_D48s_v4" + }, + { + "name": "StandardD64SV4", + "value": "Standard_D64s_v4" + }, + { + "name": "StandardD2DV4", + "value": "Standard_D2d_v4" + }, + { + "name": "StandardD4DV4", + "value": "Standard_D4d_v4" + }, + { + "name": "StandardD8DV4", + "value": "Standard_D8d_v4" + }, + { + "name": "StandardD16DV4", + "value": "Standard_D16d_v4" + }, + { + "name": "StandardD32DV4", + "value": "Standard_D32d_v4" + }, + { + "name": "StandardD48DV4", + "value": "Standard_D48d_v4" + }, + { + "name": "StandardD64DV4", + "value": "Standard_D64d_v4" + }, + { + "name": "StandardD2DsV4", + "value": "Standard_D2ds_v4" + }, + { + "name": "StandardD4DsV4", + "value": "Standard_D4ds_v4" + }, + { + "name": "StandardD8DsV4", + "value": "Standard_D8ds_v4" + }, + { + "name": "StandardD16DsV4", + "value": "Standard_D16ds_v4" + }, + { + "name": "StandardD32DsV4", + "value": "Standard_D32ds_v4" + }, + { + "name": "StandardD48DsV4", + "value": "Standard_D48ds_v4" + }, + { + "name": "StandardD64DsV4", + "value": "Standard_D64ds_v4" + }, + { + "name": "StandardE2V4", + "value": "Standard_E2_v4" + }, + { + "name": "StandardE4V4", + "value": "Standard_E4_v4" + }, + { + "name": "StandardE8V4", + "value": "Standard_E8_v4" + }, + { + "name": "StandardE16V4", + "value": "Standard_E16_v4" + }, + { + "name": "StandardE20V4", + "value": "Standard_E20_v4" + }, + { + "name": "StandardE32V4", + "value": "Standard_E32_v4" + }, + { + "name": "StandardE48V4", + "value": "Standard_E48_v4" + }, + { + "name": "StandardE64V4", + "value": "Standard_E64_v4" + }, + { + "name": "StandardE2SV4", + "value": "Standard_E2s_v4" + }, + { + "name": "StandardE4SV4", + "value": "Standard_E4s_v4" + }, + { + "name": "StandardE8SV4", + "value": "Standard_E8s_v4" + }, + { + "name": "StandardE16SV4", + "value": "Standard_E16s_v4" + }, + { + "name": "StandardE20SV4", + "value": "Standard_E20s_v4" + }, + { + "name": "StandardE32SV4", + "value": "Standard_E32s_v4" + }, + { + "name": "StandardE48SV4", + "value": "Standard_E48s_v4" + }, + { + "name": "StandardE64SV4", + "value": "Standard_E64s_v4" + }, + { + "name": "StandardE2DV4", + "value": "Standard_E2d_v4" + }, + { + "name": "StandardE4DV4", + "value": "Standard_E4d_v4" + }, + { + "name": "StandardE8DV4", + "value": "Standard_E8d_v4" + }, + { + "name": "StandardE16DV4", + "value": "Standard_E16d_v4" + }, + { + "name": "StandardE20DV4", + "value": "Standard_E20d_v4" + }, + { + "name": "StandardE32DV4", + "value": "Standard_E32d_v4" + }, + { + "name": "StandardE48DV4", + "value": "Standard_E48d_v4" + }, + { + "name": "StandardE64DV4", + "value": "Standard_E64d_v4" + }, + { + "name": "StandardE2DsV4", + "value": "Standard_E2ds_v4" + }, + { + "name": "StandardE4DsV4", + "value": "Standard_E4ds_v4" + }, + { + "name": "StandardE8DsV4", + "value": "Standard_E8ds_v4" + }, + { + "name": "StandardE16DsV4", + "value": "Standard_E16ds_v4" + }, + { + "name": "StandardE20DsV4", + "value": "Standard_E20ds_v4" + }, + { + "name": "StandardE32DsV4", + "value": "Standard_E32ds_v4" + }, + { + "name": "StandardE48DsV4", + "value": "Standard_E48ds_v4" + }, + { + "name": "StandardE64DsV4", + "value": "Standard_E64ds_v4" + }, + { + "name": "StandardE2AsV4", + "value": "Standard_E2as_v4" + }, + { + "name": "StandardE4AsV4", + "value": "Standard_E4as_v4" + }, + { + "name": "StandardE8AsV4", + "value": "Standard_E8as_v4" + }, + { + "name": "StandardE16AsV4", + "value": "Standard_E16as_v4" + }, + { + "name": "StandardE20AsV4", + "value": "Standard_E20as_v4" + }, + { + "name": "StandardE32AsV4", + "value": "Standard_E32as_v4" + }, + { + "name": "StandardE48AsV4", + "value": "Standard_E48as_v4" + }, + { + "name": "StandardE64AsV4", + "value": "Standard_E64as_v4" + }, + { + "name": "StandardE96AsV4", + "value": "Standard_E96as_v4" + }, + { + "name": "StandardD2AsV4", + "value": "Standard_D2as_v4" + }, + { + "name": "StandardD4AsV4", + "value": "Standard_D4as_v4" + }, + { + "name": "StandardD8AsV4", + "value": "Standard_D8as_v4" + }, + { + "name": "StandardD16AsV4", + "value": "Standard_D16as_v4" + }, + { + "name": "StandardD32AsV4", + "value": "Standard_D32as_v4" + }, + { + "name": "StandardD48AsV4", + "value": "Standard_D48as_v4" + }, + { + "name": "StandardD64AsV4", + "value": "Standard_D64as_v4" + }, + { + "name": "StandardD96AsV4", + "value": "Standard_D96as_v4" + }, + { + "name": "StandardM208MsV2", + "value": "Standard_M208ms_v2" + }, + { + "name": "StandardM208SV2", + "value": "Standard_M208s_v2" + }, + { + "name": "StandardM416MsV2", + "value": "Standard_M416ms_v2" + }, + { + "name": "StandardM416SV2", + "value": "Standard_M416s_v2" + }, + { + "name": "StandardF48SV2", + "value": "Standard_F48s_v2" + }, + { + "name": "StandardE48V3", + "value": "Standard_E48_v3" + }, + { + "name": "StandardE48SV3", + "value": "Standard_E48s_v3" + }, + { + "name": "StandardE80IsV4", + "value": "Standard_E80is_v4" + }, + { + "name": "StandardE80IdsV4", + "value": "Standard_E80ids_v4" + }, + { + "name": "StandardE2AV4", + "value": "Standard_E2a_v4" + }, + { + "name": "StandardE4AV4", + "value": "Standard_E4a_v4" + }, + { + "name": "StandardE8AV4", + "value": "Standard_E8a_v4" + }, + { + "name": "StandardE16AV4", + "value": "Standard_E16a_v4" + }, + { + "name": "StandardE20AV4", + "value": "Standard_E20a_v4" + }, + { + "name": "StandardE32AV4", + "value": "Standard_E32a_v4" + }, + { + "name": "StandardE48AV4", + "value": "Standard_E48a_v4" + }, + { + "name": "StandardE64AV4", + "value": "Standard_E64a_v4" + }, + { + "name": "StandardE96AV4", + "value": "Standard_E96a_v4" + }, + { + "name": "StandardD2AV4", + "value": "Standard_D2a_v4" + }, + { + "name": "StandardD4AV4", + "value": "Standard_D4a_v4" + }, + { + "name": "StandardD8AV4", + "value": "Standard_D8a_v4" + }, + { + "name": "StandardD16AV4", + "value": "Standard_D16a_v4" + }, + { + "name": "StandardD32AV4", + "value": "Standard_D32a_v4" + }, + { + "name": "StandardD48AV4", + "value": "Standard_D48a_v4" + }, + { + "name": "StandardD64AV4", + "value": "Standard_D64a_v4" + }, + { + "name": "StandardD96AV4", + "value": "Standard_D96a_v4" + }, + { + "name": "StandardM32MsV2", + "value": "Standard_M32ms_v2" + }, + { + "name": "StandardM64SV2", + "value": "Standard_M64s_v2" + }, + { + "name": "StandardM64MsV2", + "value": "Standard_M64ms_v2" + }, + { + "name": "StandardM128SV2", + "value": "Standard_M128s_v2" + }, + { + "name": "StandardM128MsV2", + "value": "Standard_M128ms_v2" + }, + { + "name": "StandardM192IsV2", + "value": "Standard_M192is_v2" + }, + { + "name": "StandardM192ImsV2", + "value": "Standard_M192ims_v2" + }, + { + "name": "StandardM32DmsV2", + "value": "Standard_M32dms_v2" + }, + { + "name": "StandardM64DsV2", + "value": "Standard_M64ds_v2" + }, + { + "name": "StandardM64DmsV2", + "value": "Standard_M64dms_v2" + }, + { + "name": "StandardM128DsV2", + "value": "Standard_M128ds_v2" + }, + { + "name": "StandardM128DmsV2", + "value": "Standard_M128dms_v2" + }, + { + "name": "StandardM192IdsV2", + "value": "Standard_M192ids_v2" + }, + { + "name": "StandardM192IdmsV2", + "value": "Standard_M192idms_v2" + }, + { + "name": "StandardD2V5", + "value": "Standard_D2_v5" + }, + { + "name": "StandardD4V5", + "value": "Standard_D4_v5" + }, + { + "name": "StandardD8V5", + "value": "Standard_D8_v5" + }, + { + "name": "StandardD16V5", + "value": "Standard_D16_v5" + }, + { + "name": "StandardD32V5", + "value": "Standard_D32_v5" + }, + { + "name": "StandardD48V5", + "value": "Standard_D48_v5" + }, + { + "name": "StandardD64V5", + "value": "Standard_D64_v5" + }, + { + "name": "StandardD96V5", + "value": "Standard_D96_v5" + }, + { + "name": "StandardD2SV5", + "value": "Standard_D2s_v5" + }, + { + "name": "StandardD4SV5", + "value": "Standard_D4s_v5" + }, + { + "name": "StandardD8SV5", + "value": "Standard_D8s_v5" + }, + { + "name": "StandardD16SV5", + "value": "Standard_D16s_v5" + }, + { + "name": "StandardD32SV5", + "value": "Standard_D32s_v5" + }, + { + "name": "StandardD48SV5", + "value": "Standard_D48s_v5" + }, + { + "name": "StandardD64SV5", + "value": "Standard_D64s_v5" + }, + { + "name": "StandardD96SV5", + "value": "Standard_D96s_v5" + }, + { + "name": "StandardD2DV5", + "value": "Standard_D2d_v5" + }, + { + "name": "StandardD4DV5", + "value": "Standard_D4d_v5" + }, + { + "name": "StandardD8DV5", + "value": "Standard_D8d_v5" + }, + { + "name": "StandardD16DV5", + "value": "Standard_D16d_v5" + }, + { + "name": "StandardD32DV5", + "value": "Standard_D32d_v5" + }, + { + "name": "StandardD48DV5", + "value": "Standard_D48d_v5" + }, + { + "name": "StandardD64DV5", + "value": "Standard_D64d_v5" + }, + { + "name": "StandardD96DV5", + "value": "Standard_D96d_v5" + }, + { + "name": "StandardD2DsV5", + "value": "Standard_D2ds_v5" + }, + { + "name": "StandardD4DsV5", + "value": "Standard_D4ds_v5" + }, + { + "name": "StandardD8DsV5", + "value": "Standard_D8ds_v5" + }, + { + "name": "StandardD16DsV5", + "value": "Standard_D16ds_v5" + }, + { + "name": "StandardD32DsV5", + "value": "Standard_D32ds_v5" + }, + { + "name": "StandardD48DsV5", + "value": "Standard_D48ds_v5" + }, + { + "name": "StandardD64DsV5", + "value": "Standard_D64ds_v5" + }, + { + "name": "StandardD96DsV5", + "value": "Standard_D96ds_v5" + }, + { + "name": "StandardD2AsV5", + "value": "Standard_D2as_v5" + }, + { + "name": "StandardD4AsV5", + "value": "Standard_D4as_v5" + }, + { + "name": "StandardD8AsV5", + "value": "Standard_D8as_v5" + }, + { + "name": "StandardD16AsV5", + "value": "Standard_D16as_v5" + }, + { + "name": "StandardD32AsV5", + "value": "Standard_D32as_v5" + }, + { + "name": "StandardD48AsV5", + "value": "Standard_D48as_v5" + }, + { + "name": "StandardD64AsV5", + "value": "Standard_D64as_v5" + }, + { + "name": "StandardD96AsV5", + "value": "Standard_D96as_v5" + }, + { + "name": "StandardD2AdsV5", + "value": "Standard_D2ads_v5" + }, + { + "name": "StandardD4AdsV5", + "value": "Standard_D4ads_v5" + }, + { + "name": "StandardD8AdsV5", + "value": "Standard_D8ads_v5" + }, + { + "name": "StandardD16AdsV5", + "value": "Standard_D16ads_v5" + }, + { + "name": "StandardD32AdsV5", + "value": "Standard_D32ads_v5" + }, + { + "name": "StandardD48AdsV5", + "value": "Standard_D48ads_v5" + }, + { + "name": "StandardD64AdsV5", + "value": "Standard_D64ads_v5" + }, + { + "name": "StandardD96AdsV5", + "value": "Standard_D96ads_v5" + }, + { + "name": "StandardE2V5", + "value": "Standard_E2_v5" + }, + { + "name": "StandardE4V5", + "value": "Standard_E4_v5" + }, + { + "name": "StandardE8V5", + "value": "Standard_E8_v5" + }, + { + "name": "StandardE16V5", + "value": "Standard_E16_v5" + }, + { + "name": "StandardE20V5", + "value": "Standard_E20_v5" + }, + { + "name": "StandardE32V5", + "value": "Standard_E32_v5" + }, + { + "name": "StandardE48V5", + "value": "Standard_E48_v5" + }, + { + "name": "StandardE64V5", + "value": "Standard_E64_v5" + }, + { + "name": "StandardE96V5", + "value": "Standard_E96_v5" + }, + { + "name": "StandardE104IV5", + "value": "Standard_E104i_v5" + }, + { + "name": "StandardE2SV5", + "value": "Standard_E2s_v5" + }, + { + "name": "StandardE4SV5", + "value": "Standard_E4s_v5" + }, + { + "name": "StandardE8SV5", + "value": "Standard_E8s_v5" + }, + { + "name": "StandardE16SV5", + "value": "Standard_E16s_v5" + }, + { + "name": "StandardE20SV5", + "value": "Standard_E20s_v5" + }, + { + "name": "StandardE32SV5", + "value": "Standard_E32s_v5" + }, + { + "name": "StandardE48SV5", + "value": "Standard_E48s_v5" + }, + { + "name": "StandardE64SV5", + "value": "Standard_E64s_v5" + }, + { + "name": "StandardE96SV5", + "value": "Standard_E96s_v5" + }, + { + "name": "StandardE104IsV5", + "value": "Standard_E104is_v5" + }, + { + "name": "StandardE2DV5", + "value": "Standard_E2d_v5" + }, + { + "name": "StandardE4DV5", + "value": "Standard_E4d_v5" + }, + { + "name": "StandardE8DV5", + "value": "Standard_E8d_v5" + }, + { + "name": "StandardE16DV5", + "value": "Standard_E16d_v5" + }, + { + "name": "StandardE20DV5", + "value": "Standard_E20d_v5" + }, + { + "name": "StandardE32DV5", + "value": "Standard_E32d_v5" + }, + { + "name": "StandardE48DV5", + "value": "Standard_E48d_v5" + }, + { + "name": "StandardE64DV5", + "value": "Standard_E64d_v5" + }, + { + "name": "StandardE96DV5", + "value": "Standard_E96d_v5" + }, + { + "name": "StandardE104IdV5", + "value": "Standard_E104id_v5" + }, + { + "name": "StandardE2DsV5", + "value": "Standard_E2ds_v5" + }, + { + "name": "StandardE4DsV5", + "value": "Standard_E4ds_v5" + }, + { + "name": "StandardE8DsV5", + "value": "Standard_E8ds_v5" + }, + { + "name": "StandardE16DsV5", + "value": "Standard_E16ds_v5" + }, + { + "name": "StandardE20DsV5", + "value": "Standard_E20ds_v5" + }, + { + "name": "StandardE32DsV5", + "value": "Standard_E32ds_v5" + }, + { + "name": "StandardE48DsV5", + "value": "Standard_E48ds_v5" + }, + { + "name": "StandardE64DsV5", + "value": "Standard_E64ds_v5" + }, + { + "name": "StandardE96DsV5", + "value": "Standard_E96ds_v5" + }, + { + "name": "StandardE104IdsV5", + "value": "Standard_E104ids_v5" + }, + { + "name": "StandardE2AsV5", + "value": "Standard_E2as_v5" + }, + { + "name": "StandardE4AsV5", + "value": "Standard_E4as_v5" + }, + { + "name": "StandardE8AsV5", + "value": "Standard_E8as_v5" + }, + { + "name": "StandardE16AsV5", + "value": "Standard_E16as_v5" + }, + { + "name": "StandardE20AsV5", + "value": "Standard_E20as_v5" + }, + { + "name": "StandardE32AsV5", + "value": "Standard_E32as_v5" + }, + { + "name": "StandardE48AsV5", + "value": "Standard_E48as_v5" + }, + { + "name": "StandardE64AsV5", + "value": "Standard_E64as_v5" + }, + { + "name": "StandardE96AsV5", + "value": "Standard_E96as_v5" + }, + { + "name": "StandardE2AdsV5", + "value": "Standard_E2ads_v5" + }, + { + "name": "StandardE4AdsV5", + "value": "Standard_E4ads_v5" + }, + { + "name": "StandardE8AdsV5", + "value": "Standard_E8ads_v5" + }, + { + "name": "StandardE16AdsV5", + "value": "Standard_E16ads_v5" + }, + { + "name": "StandardE20AdsV5", + "value": "Standard_E20ads_v5" + }, + { + "name": "StandardE32AdsV5", + "value": "Standard_E32ads_v5" + }, + { + "name": "StandardE48AdsV5", + "value": "Standard_E48ads_v5" + }, + { + "name": "StandardE64AdsV5", + "value": "Standard_E64ads_v5" + }, + { + "name": "StandardE96AdsV5", + "value": "Standard_E96ads_v5" + }, + { + "name": "StandardM82Ms", + "value": "Standard_M8_2ms" + }, + { + "name": "StandardM84Ms", + "value": "Standard_M8_4ms" + }, + { + "name": "StandardM164Ms", + "value": "Standard_M16_4ms" + }, + { + "name": "StandardM168Ms", + "value": "Standard_M16_8ms" + }, + { + "name": "StandardM328Ms", + "value": "Standard_M32_8ms" + }, + { + "name": "StandardM3216Ms", + "value": "Standard_M32_16ms" + }, + { + "name": "StandardM6432Ms", + "value": "Standard_M64_32ms" + }, + { + "name": "StandardM6416Ms", + "value": "Standard_M64_16ms" + }, + { + "name": "StandardM12864Ms", + "value": "Standard_M128_64ms" + }, + { + "name": "StandardM12832Ms", + "value": "Standard_M128_32ms" + }, + { + "name": "StandardE42SV3", + "value": "Standard_E4_2s_v3" + }, + { + "name": "StandardE84SV3", + "value": "Standard_E8_4s_v3" + }, + { + "name": "StandardE82SV3", + "value": "Standard_E8_2s_v3" + }, + { + "name": "StandardE168SV3", + "value": "Standard_E16_8s_v3" + }, + { + "name": "StandardE164SV3", + "value": "Standard_E16_4s_v3" + }, + { + "name": "StandardE3216SV3", + "value": "Standard_E32_16s_v3" + }, + { + "name": "StandardE328SV3", + "value": "Standard_E32_8s_v3" + }, + { + "name": "StandardE6432SV3", + "value": "Standard_E64_32s_v3" + }, + { + "name": "StandardE6416SV3", + "value": "Standard_E64_16s_v3" + }, + { + "name": "StandardE42SV4", + "value": "Standard_E4_2s_v4" + }, + { + "name": "StandardE84SV4", + "value": "Standard_E8_4s_v4" + }, + { + "name": "StandardE82SV4", + "value": "Standard_E8_2s_v4" + }, + { + "name": "StandardE168SV4", + "value": "Standard_E16_8s_v4" + }, + { + "name": "StandardE164SV4", + "value": "Standard_E16_4s_v4" + }, + { + "name": "StandardE3216SV4", + "value": "Standard_E32_16s_v4" + }, + { + "name": "StandardE328SV4", + "value": "Standard_E32_8s_v4" + }, + { + "name": "StandardE6432SV4", + "value": "Standard_E64_32s_v4" + }, + { + "name": "StandardE6416SV4", + "value": "Standard_E64_16s_v4" + }, + { + "name": "StandardE42DsV4", + "value": "Standard_E4_2ds_v4" + }, + { + "name": "StandardE84DsV4", + "value": "Standard_E8_4ds_v4" + }, + { + "name": "StandardE82DsV4", + "value": "Standard_E8_2ds_v4" + }, + { + "name": "StandardE168DsV4", + "value": "Standard_E16_8ds_v4" + }, + { + "name": "StandardE164DsV4", + "value": "Standard_E16_4ds_v4" + }, + { + "name": "StandardE3216DsV4", + "value": "Standard_E32_16ds_v4" + }, + { + "name": "StandardE328DsV4", + "value": "Standard_E32_8ds_v4" + }, + { + "name": "StandardE6432DsV4", + "value": "Standard_E64_32ds_v4" + }, + { + "name": "StandardE6416DsV4", + "value": "Standard_E64_16ds_v4" + }, + { + "name": "StandardE42AsV4", + "value": "Standard_E4_2as_v4" + }, + { + "name": "StandardE84AsV4", + "value": "Standard_E8_4as_v4" + }, + { + "name": "StandardE82AsV4", + "value": "Standard_E8_2as_v4" + }, + { + "name": "StandardE168AsV4", + "value": "Standard_E16_8as_v4" + }, + { + "name": "StandardE164AsV4", + "value": "Standard_E16_4as_v4" + }, + { + "name": "StandardE3216AsV4", + "value": "Standard_E32_16as_v4" + }, + { + "name": "StandardE328AsV4", + "value": "Standard_E32_8as_v4" + }, + { + "name": "StandardE6432AsV4", + "value": "Standard_E64_32as_v4" + }, + { + "name": "StandardE6416AsV4", + "value": "Standard_E64_16as_v4" + }, + { + "name": "StandardE9648AsV4", + "value": "Standard_E96_48as_v4" + }, + { + "name": "StandardE9624AsV4", + "value": "Standard_E96_24as_v4" + }, + { + "name": "StandardE42AdsV5", + "value": "Standard_E4_2ads_v5" + }, + { + "name": "StandardE84AdsV5", + "value": "Standard_E8_4ads_v5" + }, + { + "name": "StandardE82AdsV5", + "value": "Standard_E8_2ads_v5" + }, + { + "name": "StandardE168AdsV5", + "value": "Standard_E16_8ads_v5" + }, + { + "name": "StandardE164AdsV5", + "value": "Standard_E16_4ads_v5" + }, + { + "name": "StandardE3216AdsV5", + "value": "Standard_E32_16ads_v5" + }, + { + "name": "StandardE328AdsV5", + "value": "Standard_E32_8ads_v5" + }, + { + "name": "StandardE6432AdsV5", + "value": "Standard_E64_32ads_v5" + }, + { + "name": "StandardE6416AdsV5", + "value": "Standard_E64_16ads_v5" + }, + { + "name": "StandardE9648AdsV5", + "value": "Standard_E96_48ads_v5" + }, + { + "name": "StandardE9624AdsV5", + "value": "Standard_E96_24ads_v5" + }, + { + "name": "StandardE42SV5", + "value": "Standard_E4_2s_v5" + }, + { + "name": "StandardE84SV5", + "value": "Standard_E8_4s_v5" + }, + { + "name": "StandardE82SV5", + "value": "Standard_E8_2s_v5" + }, + { + "name": "StandardE168SV5", + "value": "Standard_E16_8s_v5" + }, + { + "name": "StandardE164SV5", + "value": "Standard_E16_4s_v5" + }, + { + "name": "StandardE3216SV5", + "value": "Standard_E32_16s_v5" + }, + { + "name": "StandardE328SV5", + "value": "Standard_E32_8s_v5" + }, + { + "name": "StandardE6432SV5", + "value": "Standard_E64_32s_v5" + }, + { + "name": "StandardE6416SV5", + "value": "Standard_E64_16s_v5" + }, + { + "name": "StandardE9648SV5", + "value": "Standard_E96_48s_v5" + }, + { + "name": "StandardE9624SV5", + "value": "Standard_E96_24s_v5" + }, + { + "name": "StandardE42DsV5", + "value": "Standard_E4_2ds_v5" + }, + { + "name": "StandardE84DsV5", + "value": "Standard_E8_4ds_v5" + }, + { + "name": "StandardE82DsV5", + "value": "Standard_E8_2ds_v5" + }, + { + "name": "StandardE168DsV5", + "value": "Standard_E16_8ds_v5" + }, + { + "name": "StandardE164DsV5", + "value": "Standard_E16_4ds_v5" + }, + { + "name": "StandardE3216DsV5", + "value": "Standard_E32_16ds_v5" + }, + { + "name": "StandardE328DsV5", + "value": "Standard_E32_8ds_v5" + }, + { + "name": "StandardE6432DsV5", + "value": "Standard_E64_32ds_v5" + }, + { + "name": "StandardE6416DsV5", + "value": "Standard_E64_16ds_v5" + }, + { + "name": "StandardE9648DsV5", + "value": "Standard_E96_48ds_v5" + }, + { + "name": "StandardE9624DsV5", + "value": "Standard_E96_24ds_v5" + }, + { + "name": "StandardE42AsV5", + "value": "Standard_E4_2as_v5" + }, + { + "name": "StandardE84AsV5", + "value": "Standard_E8_4as_v5" + }, + { + "name": "StandardE82AsV5", + "value": "Standard_E8_2as_v5" + }, + { + "name": "StandardE168AsV5", + "value": "Standard_E16_8as_v5" + }, + { + "name": "StandardE164AsV5", + "value": "Standard_E16_4as_v5" + }, + { + "name": "StandardE3216AsV5", + "value": "Standard_E32_16as_v5" + }, + { + "name": "StandardE328AsV5", + "value": "Standard_E32_8as_v5" + }, + { + "name": "StandardE6432AsV5", + "value": "Standard_E64_32as_v5" + }, + { + "name": "StandardE6416AsV5", + "value": "Standard_E64_16as_v5" + }, + { + "name": "StandardE9648AsV5", + "value": "Standard_E96_48as_v5" + }, + { + "name": "StandardE9624AsV5", + "value": "Standard_E96_24as_v5" + }, + { + "name": "StandardGS48", + "value": "Standard_GS4_8" + }, + { + "name": "StandardGS44", + "value": "Standard_GS4_4" + }, + { + "name": "StandardGS516", + "value": "Standard_GS5_16" + }, + { + "name": "StandardGS58", + "value": "Standard_GS5_8" + }, + { + "name": "StandardDS111V2", + "value": "Standard_DS11_1_v2" + }, + { + "name": "StandardDS122V2", + "value": "Standard_DS12_2_v2" + }, + { + "name": "StandardDS121V2", + "value": "Standard_DS12_1_v2" + }, + { + "name": "StandardDS134V2", + "value": "Standard_DS13_4_v2" + }, + { + "name": "StandardDS132V2", + "value": "Standard_DS13_2_v2" + }, + { + "name": "StandardDS148V2", + "value": "Standard_DS14_8_v2" + }, + { + "name": "StandardDS144V2", + "value": "Standard_DS14_4_v2" + }, + { + "name": "StandardM416208SV2", + "value": "Standard_M416_208s_v2" + }, + { + "name": "StandardM416208MsV2", + "value": "Standard_M416_208ms_v2" + }, + { + "name": "StandardE2BsV5", + "value": "Standard_E2bs_v5" + }, + { + "name": "StandardE4BsV5", + "value": "Standard_E4bs_v5" + }, + { + "name": "StandardE8BsV5", + "value": "Standard_E8bs_v5" + }, + { + "name": "StandardE16BsV5", + "value": "Standard_E16bs_v5" + }, + { + "name": "StandardE32BsV5", + "value": "Standard_E32bs_v5" + }, + { + "name": "StandardE48BsV5", + "value": "Standard_E48bs_v5" + }, + { + "name": "StandardE64BsV5", + "value": "Standard_E64bs_v5" + }, + { + "name": "StandardE2BdsV5", + "value": "Standard_E2bds_v5" + }, + { + "name": "StandardE4BdsV5", + "value": "Standard_E4bds_v5" + }, + { + "name": "StandardE8BdsV5", + "value": "Standard_E8bds_v5" + }, + { + "name": "StandardE16BdsV5", + "value": "Standard_E16bds_v5" + }, + { + "name": "StandardE32BdsV5", + "value": "Standard_E32bds_v5" + }, + { + "name": "StandardE48BdsV5", + "value": "Standard_E48bds_v5" + }, + { + "name": "StandardE64BdsV5", + "value": "Standard_E64bds_v5" + } + ] + } + }, + "AzureVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "RecommendedSizeHasLessNetworkAdapters", + "CannotReportComputeCost", + "CannotReportStorageCost", + "CannotReportBandwidthCosts", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "GuestOperatingSystemArchitectureNotSupported", + "GuestOperatingSystemNotSupported", + "BootTypeNotSupported", + "MoreDisksThanSupported", + "NoSuitableVmSizeFound", + "OneOrMoreDisksNotSuitable", + "OneOrMoreAdaptersNotSuitable", + "InternalErrorOccurredDuringComputeEvaluation", + "InternalErrorOccurredDuringStorageEvaluation", + "InternalErrorOccurredDuringNetworkEvaluation", + "NoVmSizeSupportsStoragePerformance", + "NoVmSizeSupportsNetworkPerformance", + "NoVmSizeForSelectedPricingTier", + "NoVmSizeForSelectedAzureLocation", + "CheckRedHatLinuxVersion", + "CheckOpenSuseLinuxVersion", + "CheckWindowsServer2008R2Version", + "CheckCentOsVersion", + "CheckDebianLinuxVersion", + "CheckSuseLinuxVersion", + "CheckOracleLinuxVersion", + "CheckUbuntuLinuxVersion", + "CheckCoreOsLinuxVersion", + "WindowsServerVersionConditionallySupported", + "NoGuestOperatingSystemConditionallySupported", + "WindowsClientVersionsConditionallySupported", + "BootTypeUnknown", + "GuestOperatingSystemUnknown", + "WindowsServerVersionsSupportedWithCaveat", + "WindowsOSNoLongerUnderMSSupport", + "EndorsedWithConditionsLinuxDistributions", + "UnendorsedLinuxDistributions", + "NoVmSizeForStandardPricingTier", + "NoVmSizeForBasicPricingTier", + "NoVmSizeInSelectedFamilyFound", + "NoEaPriceFoundForVmSize", + "NoVmSizeFoundForOfferCurrencyReservedInstance" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureWebAppSuitabilityIssueCategory": { + "type": "string", + "enum": [ + "Unknown", + "Issue", + "Info" + ], + "x-ms-enum": { + "name": "AzureWebAppSuitabilityIssueCategory", + "modelAsString": true + } + }, + "AzureWebAppTargetType": { + "type": "string", + "enum": [ + "Unknown", + "AzureAppService", + "AzureAppServiceContainer" + ], + "x-ms-enum": { + "name": "AzureWebAppTargetType", + "modelAsString": true + } + }, + "AzureWebAppTier": { + "type": "string", + "enum": [ + "Unknown", + "Free", + "Premium_V2", + "Premium_V3", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureWebAppTier", + "modelAsString": true + } + }, + "BusinessCase": { + "type": "object", + "description": "Business case resource.", + "properties": { + "properties": { + "$ref": "#/definitions/BusinessCaseProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BusinessCaseCurrency": { + "type": "string", + "description": "Business case supported currency types.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "BusinessCaseCurrency", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Currency Unknown." + }, + { + "name": "USD", + "value": "USD", + "description": "Currency USD." + }, + { + "name": "DKK", + "value": "DKK", + "description": "Currency DKK." + }, + { + "name": "CAD", + "value": "CAD", + "description": "Currency CAD." + }, + { + "name": "IDR", + "value": "IDR", + "description": "Currency IDR." + }, + { + "name": "JPY", + "value": "JPY", + "description": "Currency JPY." + }, + { + "name": "KRW", + "value": "KRW", + "description": "Currency KRW." + }, + { + "name": "NZD", + "value": "NZD", + "description": "Currency NZD." + }, + { + "name": "NOK", + "value": "NOK", + "description": "Currency NOK." + }, + { + "name": "RUB", + "value": "RUB", + "description": "Currency RUB." + }, + { + "name": "SAR", + "value": "SAR", + "description": "Currency SAR." + }, + { + "name": "ZAR", + "value": "ZAR", + "description": "Currency ZAR." + }, + { + "name": "SEK", + "value": "SEK", + "description": "Currency SEK." + }, + { + "name": "TRY", + "value": "TRY", + "description": "Currency TRY." + }, + { + "name": "GBP", + "value": "GBP", + "description": "Currency GBP." + }, + { + "name": "MXN", + "value": "MXN", + "description": "Currency MXN." + }, + { + "name": "MYR", + "value": "MYR", + "description": "Currency MYR." + }, + { + "name": "INR", + "value": "INR", + "description": "Currency INR." + }, + { + "name": "HKD", + "value": "HKD", + "description": "Currency HKD." + }, + { + "name": "BRL", + "value": "BRL", + "description": "Currency BRL." + }, + { + "name": "TWD", + "value": "TWD", + "description": "Currency TWD." + }, + { + "name": "EUR", + "value": "EUR", + "description": "Currency EUR." + }, + { + "name": "CHF", + "value": "CHF", + "description": "Currency CHF." + }, + { + "name": "ARS", + "value": "ARS", + "description": "Currency ARS." + }, + { + "name": "AUD", + "value": "AUD", + "description": "Currency AUD." + }, + { + "name": "CNY", + "value": "CNY", + "description": "Currency CNY." + } + ] + } + }, + "BusinessCaseListResult": { + "type": "object", + "description": "The response of a BusinessCase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BusinessCase items on this page", + "items": { + "$ref": "#/definitions/BusinessCase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BusinessCaseProperties": { + "type": "object", + "description": "Property bag for an\nMicrosoft.Azure.Migrate.BusinessCaseService.Api.V20220202_preview.Resources.BusinessCase\nresource.", + "properties": { + "settings": { + "$ref": "#/definitions/Settings", + "description": "Business case settings." + }, + "state": { + "$ref": "#/definitions/BusinessCaseState", + "description": "Business case state.", + "readOnly": true + }, + "reportStatusDetails": { + "type": "array", + "description": "Gets the state of business case reports.", + "items": { + "$ref": "#/definitions/ReportDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "BusinessCaseState": { + "type": "string", + "description": "Business case supported state types.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "OutDated", + "Invalid", + "OutOfSync", + "Failed" + ], + "x-ms-enum": { + "name": "BusinessCaseState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown State." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress State." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed State." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "OutDated State." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Invalid State." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "OutOfSync State." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed State." + } + ] + } + }, + "Check": { + "type": "object", + "description": "Data model of Check or Rule for Suitability Analysis.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "behavior": { + "$ref": "#/definitions/CheckResult", + "description": "Gets behavior or check result.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Gets description.", + "readOnly": true + }, + "cause": { + "type": "string", + "description": "Gets cause.", + "readOnly": true + }, + "recommendation": { + "type": "string", + "description": "Gets recommendation.", + "readOnly": true + }, + "moreInfo": { + "$ref": "#/definitions/MoreInfo", + "description": "Gets more information about check or rule.", + "readOnly": true + } + }, + "required": [ + "name", + "behavior", + "description", + "cause", + "recommendation", + "moreInfo" + ] + }, + "CheckResult": { + "type": "string", + "description": "Suitability Check or Rule Result.", + "enum": [ + "Unknown", + "Issue", + "Warn", + "Pass" + ], + "x-ms-enum": { + "name": "CheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates missing value." + }, + { + "name": "Issue", + "value": "Issue", + "description": "Indicates Migration Issue." + }, + { + "name": "Warn", + "value": "Warn", + "description": "Indicates Migration Warning." + }, + { + "name": "Pass", + "value": "Pass", + "description": "Indicates check is passed." + } + ] + } + }, + "CloudSuitability": { + "type": "string", + "description": "Cloud Suitability for Azure.", + "enum": [ + "Unknown", + "NotSuitable", + "Suitable", + "ConditionallySuitable", + "ReadinessUnknown" + ], + "x-ms-enum": { + "name": "CloudSuitability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + }, + { + "name": "ConditionallySuitable", + "value": "ConditionallySuitable", + "description": "Conditionally Suitable for Azure." + }, + { + "name": "ReadinessUnknown", + "value": "ReadinessUnknown", + "description": "Unknown Readiness for Azure." + } + ] + } + }, + "Cluster": { + "type": "object", + "description": "Data model of Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "nodePools": { + "type": "array", + "description": "Gets list of node pools.", + "items": { + "$ref": "#/definitions/NodePool" + }, + "readOnly": true + }, + "region": { + "type": "string", + "description": "Gets region.", + "readOnly": true + }, + "userNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node pool count.", + "readOnly": true + }, + "userNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node count.", + "readOnly": true + }, + "systemNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node pool count.", + "readOnly": true + }, + "systemNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "name", + "nodePools", + "region", + "userNodePoolCount", + "userNodeCount", + "systemNodePoolCount", + "systemNodeCount", + "podCount", + "monthlyCost" + ] + }, + "CollectorAgentPropertiesBase": { + "type": "object", + "description": "Collector agent property class.", + "properties": { + "id": { + "type": "string", + "description": "Gets the collector agent id." + }, + "version": { + "type": "string", + "description": "Gets the collector agent version." + }, + "lastHeartbeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the collector last heartbeat time." + }, + "spnDetails": { + "$ref": "#/definitions/CollectorAgentSpnPropertiesBase", + "description": "Gets or sets the SPN details." + } + } + }, + "CollectorAgentSpnPropertiesBase": { + "type": "object", + "description": "Collector agent SPN details class.", + "properties": { + "authority": { + "type": "string", + "description": "Gets the AAD authority endpoint." + }, + "applicationId": { + "type": "string", + "description": "Gets the AAD application id." + }, + "audience": { + "type": "string", + "description": "Gets the AAD audience url." + }, + "objectId": { + "type": "string", + "description": "Gets the object id of the AAD application." + }, + "tenantId": { + "type": "string", + "description": "Gets the tenant id of the AAD application." + } + } + }, + "CollectorPropertiesBase": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CompareSummary": { + "type": "object", + "description": "Compare summary class.", + "properties": { + "azurePaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure PaaS cost.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure IaaS cost.", + "readOnly": true + }, + "azureAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The AVS cost.", + "readOnly": true + }, + "onPremisesPaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS cost.", + "readOnly": true + }, + "onPremisesAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS cost.", + "readOnly": true + }, + "onPremisesPaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesIaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesAvsDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS decommissioned cost.", + "readOnly": true + }, + "futureCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "Future state cost which includes Azure cost and Arc enabled on-premises cost based on the final migration percentage.", + "readOnly": true + }, + "azureArcEnabledOnPremisesCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The Azure arc enabled on-premises cost.", + "readOnly": true + }, + "futureAzureArcEnabledOnPremisesCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The final azure arc enabled on-premises cost based on the final migration percentage.", + "readOnly": true + } + } + }, + "CompatibilityLevel": { + "type": "string", + "enum": [ + "Unknown", + "CompatLevel80", + "CompatLevel90", + "CompatLevel100", + "CompatLevel110", + "CompatLevel120", + "CompatLevel130", + "CompatLevel140", + "CompatLevel150" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "ComputeResource": { + "type": "object", + "description": "Data model of Cores and Memory Compute Resource.", + "properties": { + "cores": { + "type": "number", + "format": "float", + "description": "Gets cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Gets memory.", + "readOnly": true + } + }, + "required": [ + "cores", + "memory" + ] + }, + "ComputeSettings": { + "type": "object", + "description": "Compute settings.", + "properties": { + "hyperthreadCoreToMemoryRatio": { + "type": "number", + "format": "float", + "description": "Hyperthread core to memory ratio." + }, + "price": { + "type": "number", + "format": "float", + "description": "Compute Price." + }, + "sqlServerLicensing": { + "type": "array", + "description": "SQL Server licensing settings.", + "items": { + "$ref": "#/definitions/SqlServerLicensingSettings" + }, + "x-ms-identifiers": [] + }, + "windowsServerLicensing": { + "$ref": "#/definitions/WindowsServerLicensingSettings", + "description": "Windows Server licensing settings." + }, + "rhelLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Rhel Server licensing settings." + }, + "suseLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Suse Server licensing settings." + }, + "virtualizationSoftwareSettings": { + "$ref": "#/definitions/VirtualizationSoftwareSettings", + "description": "Virtualization software settings." + } + }, + "required": [ + "hyperthreadCoreToMemoryRatio", + "price", + "sqlServerLicensing", + "windowsServerLicensing", + "rhelLinuxServerLicensing", + "suseLinuxServerLicensing", + "virtualizationSoftwareSettings" + ] + }, + "ComputeTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Provisioned", + "Serverless" + ], + "x-ms-enum": { + "name": "ComputeTier", + "modelAsString": true + } + }, + "ConsolidationType": { + "type": "string", + "description": "Consolidation Type.", + "enum": [ + "Full", + "AsOnSource" + ], + "x-ms-enum": { + "name": "ConsolidationType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full Consolidation." + }, + { + "name": "AsOnSource", + "value": "AsOnSource", + "description": "As On Source or On Premises Consolidation." + } + ] + } + }, + "CostByStorageType": { + "type": "object", + "description": "The cost by storage type.", + "properties": { + "storageType": { + "type": "string", + "description": "The storage type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost per storage type.", + "readOnly": true + } + } + }, + "CostComponent": { + "type": "object", + "description": "Class to represent the component of the cost.", + "properties": { + "name": { + "$ref": "#/definitions/CostComponentName", + "description": "Gets the name of the component.", + "readOnly": true + }, + "value": { + "type": "number", + "format": "float", + "description": "The value of the component." + }, + "description": { + "type": "string", + "description": "The textual description of the component." + } + } + }, + "CostComponentName": { + "type": "string", + "description": "Enum to represent component name.", + "enum": [ + "Unknown", + "MonthlyAzureHybridCostSavings", + "MonthlySecurityCost", + "MonthlyPremiumV2StorageCost", + "MonthlyLinuxAzureHybridCostSavings", + "MonthlyAvsNodeCost", + "MonthlyAvsExternalStorageCost", + "MonthlyAvsNetworkCost", + "MonthlyVcfByolCostDifference" + ], + "x-ms-enum": { + "name": "CostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default Cost Component name represented by Unknown." + }, + { + "name": "MonthlyAzureHybridCostSavings", + "value": "MonthlyAzureHybridCostSavings", + "description": "Cost Savings due to Windows Azure Hybrid on monthly basis." + }, + { + "name": "MonthlySecurityCost", + "value": "MonthlySecurityCost", + "description": "Monthly security cost." + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": "MonthlyPremiumV2StorageCost", + "description": "Monthly PremiumV2 Storage Cost." + }, + { + "name": "MonthlyLinuxAzureHybridCostSavings", + "value": "MonthlyLinuxAzureHybridCostSavings", + "description": "Cost Savings due to Linux Azure Hybrid on monthly basis." + }, + { + "name": "MonthlyAvsNodeCost", + "value": "MonthlyAvsNodeCost", + "description": "Monthly AVS Node cost" + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": "MonthlyAvsExternalStorageCost", + "description": "Monthly AVS External Storage cost" + }, + { + "name": "MonthlyAvsNetworkCost", + "value": "MonthlyAvsNetworkCost", + "description": "Monthly AVS Network cost" + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": "MonthlyVcfByolCostDifference", + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ] + } + }, + "CostDetails": { + "type": "object", + "description": "The on premises PaaS cost.", + "properties": { + "storageCost": { + "type": "number", + "format": "float", + "description": "The storage cost.", + "readOnly": true + }, + "computeCost": { + "type": "number", + "format": "float", + "description": "The compute cost.", + "readOnly": true + }, + "itLaborCost": { + "type": "number", + "format": "float", + "description": "The IT labor cost.", + "readOnly": true + }, + "networkCost": { + "type": "number", + "format": "float", + "description": "The network cost.", + "readOnly": true + }, + "ahubSavings": { + "type": "number", + "format": "float", + "description": "The windows AhubSavings.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux AhubSavings.", + "readOnly": true + }, + "securityCost": { + "type": "number", + "format": "float", + "description": "Security Cost.", + "readOnly": true + }, + "managementCostDetails": { + "$ref": "#/definitions/ManagementCostDetails", + "description": "Management Cost Details.", + "readOnly": true + }, + "esuSavings": { + "type": "number", + "format": "float", + "description": "esu savings.", + "readOnly": true + }, + "facilitiesCost": { + "type": "number", + "format": "float", + "description": "The facilities cost related to hosting customer workloads in a datacenter.", + "readOnly": true + } + } + }, + "DiscoveredEntitiesSummary": { + "type": "object", + "description": "Discovered entities summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Number of web servers", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web apps", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines", + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Web server summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Web app summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "DiscoveredEntityLightSummary": { + "type": "object", + "description": "Discovered entity light summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers." + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web apps." + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines." + } + }, + "required": [ + "numberOfServers", + "numberOfWebApps", + "numberOfMachines" + ] + }, + "DiscoverySource": { + "type": "string", + "description": "Business case supported Discovery source types.", + "enum": [ + "Unknown", + "Appliance", + "Import" + ], + "x-ms-enum": { + "name": "DiscoverySource", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Discovery Source." + }, + { + "name": "Appliance", + "value": "Appliance", + "description": "Appliance Discovery Source." + }, + { + "name": "Import", + "value": "Import", + "description": "Import Discovery Source." + } + ] + } + }, + "Disk": { + "type": "object", + "description": "A disk discovered on a machine.", + "properties": { + "gigabytesAllocated": { + "type": "number", + "format": "float", + "description": "Gigabytes of storage provisioned for this disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the disk.", + "readOnly": true + } + } + }, + "DistributionByOperatingSystem": { + "type": "object", + "description": "The distribution by operating system.", + "properties": { + "osClassificationType": { + "type": "string", + "description": "The Os classification type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the OS type classification.", + "readOnly": true + } + } + }, + "DistributionByType": { + "type": "object", + "description": "Distribution by Type.", + "properties": { + "type": { + "type": "string", + "description": "Distribution Type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Distribution Count.", + "readOnly": true + } + } + }, + "DistributionByVirtualization": { + "type": "object", + "description": "The distribution by virtualization.", + "properties": { + "virtualizationType": { + "type": "string", + "description": "The Virtualization type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the Virtualization type classification.", + "readOnly": true + } + } + }, + "DownloadUrl": { + "type": "object", + "description": "Data model of Download URL for assessment report.", + "properties": { + "assessmentReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + }, + "required": [ + "assessmentReportUrl", + "expirationTime" + ] + }, + "EntityUptime": { + "type": "object", + "description": "Entity Uptime.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Gets the days per month." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Gets the hours per day." + } + } + }, + "EnvironmentType": { + "type": "string", + "enum": [ + "Production", + "Test" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + } + }, + "Error": { + "type": "object", + "description": "Error web model class.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the Run as account ID.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the Appliance name.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "agentScenario": { + "type": "string", + "description": "Gets the agent scenario where this error occurred.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the error possible causes.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action for the error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the error message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "impactedAssessmentType": { + "type": "string", + "description": "Gets the type of assessment impacted by this error.", + "readOnly": true + } + } + }, + "ErrorSummary": { + "type": "object", + "description": "Error summary containing affected entities for each type of assessment.", + "properties": { + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Gets the assessment type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets the affected entity count.", + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error Details", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Description of the error occurred", + "readOnly": true + } + }, + "required": [ + "code", + "message" + ] + }, + "EstimatedCostByOffer": { + "type": "object", + "description": "The estimated cost by offer.", + "properties": { + "offerName": { + "type": "string", + "description": "The offer name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost for the offer.", + "readOnly": true + } + } + }, + "EstimatedCostByTarget": { + "type": "object", + "description": "Shows the estimated cost by target.", + "properties": { + "azureSqlMiCost": { + "type": "number", + "format": "float", + "description": "Azure SQL MI cost.", + "readOnly": true + }, + "azureSqlDbCost": { + "type": "number", + "format": "float", + "description": "Azure SQL DB cost.", + "readOnly": true + }, + "appServiceCost": { + "type": "number", + "format": "float", + "description": "Azure App Service cost.", + "readOnly": true + }, + "appServiceContainerCost": { + "type": "number", + "format": "float", + "description": "Azure App Service Containers cost.", + "readOnly": true + }, + "azureKubernetesServiceCost": { + "type": "number", + "format": "float", + "description": "Azure Kubernetes Service cost.", + "readOnly": true + } + } + }, + "EstimatedExternalStorage": { + "type": "object", + "description": "Estimated external storage", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "External storage type", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Total storage allocation in GB", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Percent storage utilization", + "readOnly": true + }, + "totalStorageCost": { + "type": "number", + "format": "float", + "description": "Total storage cost", + "readOnly": true + } + } + }, + "EstimatedNetwork": { + "type": "object", + "description": "Estimated network", + "properties": { + "skuType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Network SKU type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Network Sku type cost.", + "readOnly": true + } + } + }, + "EvaluatedAvsMachine": { + "type": "object", + "description": "Evaluated AVS machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedAvsMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedAvsMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedAvsMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedAvsMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedAvsMachineProperties": { + "type": "object", + "description": "Evaluated AVS machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedMachine": { + "type": "object", + "description": "Evaluated machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedMachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedMachineProperties": { + "type": "object", + "description": "Evaluated machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedSqlEntity": { + "type": "object", + "description": "Evaluated sql entity resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedSqlEntityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedSqlEntityListResult": { + "type": "object", + "description": "The response of a EvaluatedSqlEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedSqlEntity items on this page", + "items": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedSqlEntityProperties": { + "type": "object", + "description": "Evaluated sql entity properties class.", + "properties": { + "serverName": { + "type": "string", + "description": "Server name.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL Server version.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL Server edition.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is SQL Instance ready for migration.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "The virtualization type.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "DB count in instance.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedWebApp": { + "type": "object", + "description": "Evaluated web app resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedWebAppProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EvaluatedWebAppListResult": { + "type": "object", + "description": "The response of a EvaluatedWebApp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedWebApp items on this page", + "items": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedWebAppProperties": { + "type": "object", + "description": "Evaluated web app properties class.", + "properties": { + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target." + }, + "recommendedAzureSkuName": { + "type": "string", + "description": "Recommended Azure SKU name." + }, + "recommendedAzureSkuSize": { + "type": "string", + "description": "Recommended Azure SKU size." + }, + "serverName": { + "type": "string", + "description": "The server name." + }, + "workload": { + "type": "string", + "description": "The workload." + }, + "activityState": { + "type": "string", + "description": "The activity state." + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration." + } + } + }, + "ExternalStorageType": { + "type": "string", + "description": "Different External storage skus.", + "enum": [ + "Unknown", + "None", + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "x-ms-enum": { + "name": "ExternalStorageType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported external storage." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No external storage." + }, + { + "name": "AnfStandard", + "value": "AnfStandard", + "description": "ANF external storage with Standard SKU." + }, + { + "name": "AnfPremium", + "value": "AnfPremium", + "description": "ANF external storage with Premium SKU." + }, + { + "name": "AnfUltra", + "value": "AnfUltra", + "description": "ANF external storage with Ultra SKU." + } + ] + } + }, + "AvsAssessmentScenario": { + "type": "string", + "description": "Scenarios with which Avs Assessments can be created.", + "enum": [ + "Unknown", + "NewAvsSddc", + "AvsSddcExpansion" + ], + "x-ms-enum": { + "name": "AvsAssessmentScenario", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown assessment scenario" + }, + { + "name": "NewAvsSddc", + "value": "NewAvsSddc", + "description": "Create Assessment for new Avs Sddc" + }, + { + "name": "AvsSddcExpansion", + "value": "AvsSddcExpansion", + "description": "Create Assessment for existing Avs Sddc" + } + ] + } + }, + "FacilitySettings": { + "type": "object", + "description": "Facility settings.", + "properties": { + "facilitiesCostPerKwh": { + "type": "number", + "format": "float", + "description": "The facilities cost." + } + } + }, + "FttAndRaidLevel": { + "type": "string", + "description": "FTT and RAID Level.", + "enum": [ + "Unknown", + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "x-ms-enum": { + "name": "FttAndRaidLevel", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown FTT and RAID Level." + }, + { + "name": "Ftt1Raid1", + "value": "Ftt1Raid1", + "description": "FTT 1 and RAID Level 1." + }, + { + "name": "Ftt1Raid5", + "value": "Ftt1Raid5", + "description": "FTT 1 and RAID Level 5." + }, + { + "name": "Ftt2Raid1", + "value": "Ftt2Raid1", + "description": "FTT 2 and RAID Level 1." + }, + { + "name": "Ftt2Raid6", + "value": "Ftt2Raid6", + "description": "FTT 2 and RAID Level 6." + }, + { + "name": "Ftt3Raid1", + "value": "Ftt3Raid1", + "description": "FTT 3 and RAID Level 1." + } + ] + } + }, + "Group": { + "type": "object", + "description": "Group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GroupBodyProperties": { + "type": "object", + "description": "Body properties of group update.", + "properties": { + "operationType": { + "$ref": "#/definitions/GroupUpdateOperation", + "description": "Whether to add or remove the machines." + }, + "machines": { + "type": "array", + "description": "List of machine names that are part of this group.", + "items": { + "type": "string" + } + } + } + }, + "GroupListResult": { + "type": "object", + "description": "The response of a Group list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Group items on this page", + "items": { + "$ref": "#/definitions/Group" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GroupProperties": { + "type": "object", + "description": "Properties of group resource.", + "properties": { + "groupStatus": { + "$ref": "#/definitions/GroupStatus", + "description": "Whether the group has been created and is valid.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of this group.", + "readOnly": true + }, + "assessments": { + "type": "array", + "description": "List of References to Assessments created on this group.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedAssessmentTypes": { + "type": "array", + "description": "List of assessment types supported on this group.", + "items": { + "$ref": "#/definitions/AssessmentType" + } + }, + "areAssessmentsRunning": { + "type": "boolean", + "description": "If the assessments are in running state.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was last updated. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "The type of group.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "GroupStatus": { + "type": "string", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid" + ], + "x-ms-enum": { + "name": "GroupStatus", + "modelAsString": true + } + }, + "GroupType": { + "type": "string", + "enum": [ + "Default", + "Import" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": true + } + }, + "GroupUpdateOperation": { + "type": "string", + "enum": [ + "Add", + "Remove" + ], + "x-ms-enum": { + "name": "GroupUpdateOperation", + "modelAsString": true + } + }, + "GuestOperatingSystemArchitecture": { + "type": "string", + "enum": [ + "Unknown", + "X86", + "X64" + ], + "x-ms-enum": { + "name": "GuestOperatingSystemArchitecture", + "modelAsString": true + } + }, + "HardwareGeneration": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Gen5", + "Fsv2_series", + "M_series", + "DC_series" + ], + "x-ms-enum": { + "name": "HardwareGeneration", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Automatic", + "value": "Automatic" + }, + { + "name": "Gen5", + "value": "Gen5" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_series" + } + ] + } + }, + "HyperVLicenseType": { + "type": "string", + "description": "Business case supported HyperV License types.", + "enum": [ + "Unknown", + "Datacentre", + "Standard" + ], + "x-ms-enum": { + "name": "HyperVLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown HyperV License." + }, + { + "name": "Datacentre", + "value": "Datacentre", + "description": "Datacentre HyperV License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard HyperV License." + } + ] + } + }, + "HypervCollector": { + "type": "object", + "description": "Hyper-V collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "HypervCollectorListResult": { + "type": "object", + "description": "The response of a HypervCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCollector items on this page", + "items": { + "$ref": "#/definitions/HypervCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervLicense": { + "type": "object", + "description": "Representation of a licence.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "licenseType": { + "$ref": "#/definitions/HyperVLicenseType", + "description": "HyperV licence type." + } + }, + "required": [ + "licenseCost", + "licenseType" + ] + }, + "HypervVirtualizationManagementSettings": { + "type": "object", + "description": "HyperV Virtualization Management Settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance Cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/HypervLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "IaasOsDistribution": { + "type": "object", + "description": "Shows the infrastructure as a service machine OS distribution.", + "properties": { + "windows": { + "type": "integer", + "format": "int32", + "description": "Number of Windows servers.", + "readOnly": true + }, + "linux": { + "type": "integer", + "format": "int32", + "description": "Number of Linux servers.", + "readOnly": true + }, + "other": { + "type": "integer", + "format": "int32", + "description": "Number of servers neither Windows or Linux.", + "readOnly": true + } + } + }, + "IaasOsLicensingDetails": { + "type": "object", + "description": "The Iaas OS licensing details.", + "properties": { + "osType": { + "type": "string", + "description": "The OS type.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionCost": { + "type": "number", + "format": "float", + "description": "The decommission cost.", + "readOnly": true + } + } + }, + "IaasSummary": { + "type": "object", + "description": "Iaas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IaasSummaryListResult": { + "type": "object", + "description": "The response of a IaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IaasSummary items on this page", + "items": { + "$ref": "#/definitions/IaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IaasSummaryProperties": { + "type": "object", + "description": "Iaas summary properties class.", + "properties": { + "azureIaasSummary": { + "$ref": "#/definitions/AzureIaasSummary", + "description": "The Azure IaaS summary.", + "readOnly": true + }, + "onPremisesIaasSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "ImpactedAssessmentObject": { + "type": "object", + "description": "Class representing the impacted objects.", + "properties": { + "objectName": { + "type": "string", + "description": "Gets the object name.", + "readOnly": true + }, + "objectType": { + "type": "string", + "description": "Gets the object type.", + "readOnly": true + } + } + }, + "ImportCollector": { + "type": "object", + "description": "Import collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBase", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImportCollectorListResult": { + "type": "object", + "description": "The response of a ImportCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportCollector items on this page", + "items": { + "$ref": "#/definitions/ImportCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LaborSettings": { + "type": "object", + "description": "Labour settings.", + "properties": { + "physicalServersPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Physical servers per administrator.", + "minimum": 1 + }, + "virtualMachinesPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Virtual machines per administrator.", + "minimum": 1 + }, + "hourlyAdminCost": { + "type": "number", + "format": "float", + "description": "Hourly administrator cost." + } + }, + "required": [ + "physicalServersPerAdmin", + "virtualMachinesPerAdmin", + "hourlyAdminCost" + ] + }, + "LicenseType": { + "type": "string", + "description": "Business case supported VmWare License types.", + "enum": [ + "Unknown", + "VSphereStandard", + "VSphereEnterprisePlus" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereStandard", + "value": "VSphereStandard", + "description": "VSphereStandard License." + }, + { + "name": "VSphereEnterprisePlus", + "value": "VSphereEnterprisePlus", + "description": "VSphereEnterprisePlus License." + } + ] + } + }, + "LicensingProgram": { + "type": "string", + "description": "Licensing Program for Azure.", + "enum": [ + "Default", + "EA" + ], + "x-ms-enum": { + "name": "LicensingProgram", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default value. Indicates Pay As You Go." + }, + { + "name": "EA", + "value": "EA", + "description": "Enterprise Agreement." + } + ] + } + }, + "Machine": { + "type": "object", + "description": "Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "MachineAssessmentProperties": { + "type": "object", + "description": "Properties of an assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets or sets the assessment error summary.\n This is the number of\nmachines affected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate ultra storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets enterprise agreement subscription id." + }, + "azurePricingTier": { + "$ref": "#/definitions/AzurePricingTier", + "description": "Gets or sets Azure Pricing Tier - Free, Basic, etc." + }, + "azureStorageRedundancy": { + "$ref": "#/definitions/AzureStorageRedundancy", + "description": "Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets the Azure Reserved Instance - 1-Year, 3-Year." + }, + "azureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the azure hybrid use\nbenefit." + }, + "linuxAzureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the linux azure hybrid use\nbenefit." + }, + "azureDiskTypes": { + "type": "array", + "description": "Gets or sets the azure storage type. Premium, Standard etc.", + "items": { + "$ref": "#/definitions/AzureDiskType" + } + }, + "azureVmFamilies": { + "type": "array", + "description": "Gets or sets the Azure VM families.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + } + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByOsName": { + "type": "object", + "description": "Gets the distribution by os name.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Compute Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Bandwidth Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Storage Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate premium storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate standard SSD storage cost for all the machines in\nthe assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Gets or sets the Cloud suitability summary for all the machines in the\nassessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of machines part of the assessment.", + "readOnly": true + }, + "vmUptime": { + "$ref": "#/definitions/VmUptime", + "description": "Gets or sets the duration for which the VMs are up in the on-premises\nenvironment." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "MachineBootType": { + "type": "string", + "enum": [ + "Unknown", + "EFI", + "BIOS", + "NotSpecified" + ], + "x-ms-enum": { + "name": "MachineBootType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "EFI", + "value": "EFI" + }, + { + "name": "Bios", + "value": "BIOS" + }, + { + "name": "NotSpecified", + "value": "NotSpecified" + } + ] + } + }, + "MachineListResult": { + "type": "object", + "description": "The response of a Machine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Machine items on this page", + "items": { + "$ref": "#/definitions/Machine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineProperties": { + "type": "object", + "description": "Properties of a machine.", + "properties": { + "workloadSummary": { + "$ref": "#/definitions/WorkloadSummary", + "description": "Gets or sets workload summary.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets Processor details of the host.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "discoveryMachineArmId": { + "type": "string", + "description": "Site id of machine discovered in private data center.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "The data center management server ARM Id for the machine.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "The data center management server name for the machine.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Disks attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/Disk" + }, + "readOnly": true + }, + "groups": { + "type": "array", + "description": "Gets the References to the groups that this machine is member of.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Network adapters attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "SQL instances discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Web applications discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + } + } + }, + "ManagementCostComponent": { + "type": "object", + "description": "Management Cost Component.", + "properties": { + "name": { + "$ref": "#/definitions/ManagementCostComponentName", + "description": "Name of Management Cost Component." + }, + "value": { + "type": "number", + "format": "float", + "description": "Cost of Management Component." + } + }, + "required": [ + "name" + ] + }, + "ManagementCostComponentName": { + "type": "string", + "description": "Management Cost Component Names.", + "enum": [ + "Unknown", + "SystemCenterLicenseCost", + "VSphereManagementCost", + "ThirdPartyManagementCost", + "OtherMonitoringCost", + "OtherDataProtectionCost", + "OtherPatchingCost", + "AzureMonitoringCost", + "AzurePatchingCost", + "AzureDataProtectionCost", + "AzureArcMonitoringCost", + "AzureArcPatchingCost" + ], + "x-ms-enum": { + "name": "ManagementCostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Management Cost Component." + }, + { + "name": "SystemCenterLicenseCost", + "value": "SystemCenterLicenseCost", + "description": "System Center License Cost." + }, + { + "name": "VSphereManagementCost", + "value": "VSphereManagementCost", + "description": "VSphere eManagement Cost." + }, + { + "name": "ThirdPartyManagementCost", + "value": "ThirdPartyManagementCost", + "description": "Third Party Management Cost." + }, + { + "name": "OtherMonitoringCost", + "value": "OtherMonitoringCost", + "description": "Other Monitoring Cost." + }, + { + "name": "OtherDataProtectionCost", + "value": "OtherDataProtectionCost", + "description": "Other Data Protection Cost." + }, + { + "name": "OtherPatchingCost", + "value": "OtherPatchingCost", + "description": "Other Patching Cost." + }, + { + "name": "AzureMonitoringCost", + "value": "AzureMonitoringCost", + "description": "Azure Monitoring Cost." + }, + { + "name": "AzurePatchingCost", + "value": "AzurePatchingCost", + "description": "Azure Patching Cost." + }, + { + "name": "AzureDataProtectionCost", + "value": "AzureDataProtectionCost", + "description": "Azure Data Protection Cost." + }, + { + "name": "AzureArcMonitoringCost", + "value": "AzureArcMonitoringCost", + "description": "Azure Arc Monitoring Cost." + }, + { + "name": "AzureArcPatchingCost", + "value": "AzureArcPatchingCost", + "description": "Azure Arc Patching Cost." + } + ] + } + }, + "ManagementCostDetails": { + "type": "object", + "description": "Management Cost Details.", + "properties": { + "managementCost": { + "type": "number", + "format": "float", + "description": "Management Cost.", + "readOnly": true + }, + "managementCostComponents": { + "type": "array", + "description": "Management Cost Components.", + "items": { + "$ref": "#/definitions/ManagementCostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ManagementSettings": { + "type": "object", + "description": "Management settings.", + "properties": { + "hypervVirtualizationManagementSettings": { + "$ref": "#/definitions/HypervVirtualizationManagementSettings", + "description": "HyperV Virtualization Management Settings." + }, + "thirdPartyManagementSettings": { + "$ref": "#/definitions/ThirdPartyManagementSettings", + "description": "Third Party Management Settings." + }, + "otherManagementCostsSettings": { + "$ref": "#/definitions/OtherManagementCostsSettings", + "description": "Other Management Costs Settings." + } + }, + "required": [ + "hypervVirtualizationManagementSettings", + "thirdPartyManagementSettings", + "otherManagementCostsSettings" + ] + }, + "MigrationGuidelineContext": { + "type": "object", + "description": "Migration Guideline Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "MigrationStrategy": { + "type": "string", + "description": "Business case supported migration strategy types.", + "enum": [ + "Unknown", + "OptimizeForCost", + "IaaSOnly", + "OptimizeForPaas", + "AVSOnly" + ], + "x-ms-enum": { + "name": "MigrationStrategy", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Migration Strategy." + }, + { + "name": "OptimizeForCost", + "value": "OptimizeForCost", + "description": "Optimize for cost." + }, + { + "name": "IaaSOnly", + "value": "IaaSOnly", + "description": "IaaS only." + }, + { + "name": "OptimizeForPaas", + "value": "OptimizeForPaas", + "description": "Optimize for PaaS." + }, + { + "name": "AVSOnly", + "value": "AVSOnly", + "description": "Avs only." + } + ] + } + }, + "MoreInfo": { + "type": "object", + "description": "Data model of More information about check or rule.", + "properties": { + "title": { + "type": "string", + "description": "Gets title.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "Gets url.", + "readOnly": true + } + }, + "required": [ + "title", + "url" + ] + }, + "MultiSubnetIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "MultiSubnetIntent", + "modelAsString": true + } + }, + "MutableArmResource": { + "type": "object", + "description": "ARM model of Assessment ARM object.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningStatus", + "description": "Gets the provisioning state.", + "readOnly": true + } + } + }, + "NetworkAdapter": { + "type": "object", + "description": "A network adapter discovered on a machine.", + "properties": { + "macAddress": { + "type": "string", + "description": "MAC Address of the network adapter.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "List of IP Addresses on the network adapter.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the network adapter.", + "readOnly": true + } + } + }, + "NetworkSettings": { + "type": "object", + "description": "Network settings.", + "properties": { + "hardwareSoftwareCostPercentage": { + "type": "number", + "format": "float", + "description": "Network hardware and software cost percentage.", + "minimum": 0, + "maximum": 100 + }, + "maintenanceCostPercentage": { + "type": "number", + "format": "float", + "description": "Network maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "hardwareSoftwareCostPercentage", + "maintenanceCostPercentage" + ] + }, + "NetworkSkuType": { + "type": "string", + "description": "Different network skus.", + "enum": [ + "Unknown", + "None", + "ExpressRouteUltra" + ], + "x-ms-enum": { + "name": "NetworkSkuType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported network SKU." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No network SKU." + }, + { + "name": "ExpressRouteUltra", + "value": "ExpressRouteUltra", + "description": "Express Route network type with Ultra SKU." + } + ] + } + }, + "NodePool": { + "type": "object", + "description": "Data model of Node Pool.", + "properties": { + "id": { + "type": "string", + "description": "Gets id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "mode": { + "$ref": "#/definitions/NodePoolMode", + "description": "Gets mode.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "armSkuName": { + "type": "string", + "description": "Gets arm sku name.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + }, + "podApproxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets pod approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "id", + "name", + "clusterName", + "mode", + "osType", + "armSkuName", + "nodeCount", + "podCount", + "monthlyCost", + "podApproxMonthlyCost" + ] + }, + "NodePoolMode": { + "type": "string", + "description": "Node Pool Mode.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "NodePoolMode", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Indicates User node pool." + }, + { + "name": "System", + "value": "System", + "description": "Indicates System node pool." + } + ] + } + }, + "OSType": { + "type": "string", + "description": "Operating System Type.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS Type." + }, + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS Type." + } + ] + } + }, + "OnPremiseSettings": { + "type": "object", + "description": "On-premise settings.", + "properties": { + "computeSettings": { + "$ref": "#/definitions/ComputeSettings", + "description": "Compute settings." + }, + "storageSettings": { + "$ref": "#/definitions/StorageSettings", + "description": "Storage settings." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "Network settings." + }, + "facilitySettings": { + "$ref": "#/definitions/FacilitySettings", + "description": "Facility settings." + }, + "laborSettings": { + "$ref": "#/definitions/LaborSettings", + "description": "Labour settings." + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security settings." + }, + "managementSettings": { + "$ref": "#/definitions/ManagementSettings", + "description": "Management settings." + } + }, + "required": [ + "computeSettings", + "storageSettings", + "networkSettings", + "facilitySettings", + "laborSettings", + "securitySettings" + ] + }, + "OnPremisesIaasSummary": { + "type": "object", + "description": "The on premises IAAS summary.", + "properties": { + "servers": { + "type": "integer", + "format": "int32", + "description": "The number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The number of cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "Total memory in GB.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "The CPU utilization.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "The memory utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "The storage utilization.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostForDecommissioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "osLicensingDetails": { + "type": "array", + "description": "The OS licensing details.", + "items": { + "$ref": "#/definitions/IaasOsLicensingDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByOperatingSystem": { + "type": "array", + "description": "The distribution by operating system.", + "items": { + "$ref": "#/definitions/DistributionByOperatingSystem" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "onPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionByVirtualization": { + "type": "array", + "description": "The distribution by virtualization.", + "items": { + "$ref": "#/definitions/DistributionByVirtualization" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "iaasOsSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas OS Support Status Distribution.", + "readOnly": true + }, + "iaasSqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + }, + "distributionByOperatingSystemVersion": { + "type": "array", + "description": "Distribution by Operating System Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by Sql Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesPaasLicensingCost": { + "type": "object", + "description": "The on premises paas licensing cost.", + "properties": { + "version": { + "type": "string", + "description": "The version.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionServerCost": { + "type": "number", + "format": "float", + "description": "The decommissioned server cost.", + "readOnly": true + } + } + }, + "OnPremisesPaasSummary": { + "type": "object", + "description": "Shows platform as a service (PaaS) summary.", + "properties": { + "totalServers": { + "type": "integer", + "format": "int32", + "description": "Total servers.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization percentage.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization percentage.", + "readOnly": true + }, + "totalOnPremisesPaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasCostForDecommisioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasLicensingCost": { + "$ref": "#/definitions/OnPremisesPaasLicensingCost", + "description": "The on premises paas licensing cost.", + "readOnly": true + }, + "onPremisesSqlSummary": { + "$ref": "#/definitions/OnPremisesSqlSummary", + "description": "The on premises SQL summary.", + "readOnly": true + }, + "onPremisesWebAppSummary": { + "$ref": "#/definitions/OnPremisesWebAppSummary", + "description": "The on premises web application summary.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + } + } + }, + "OnPremisesSqlSummary": { + "type": "object", + "description": "The on premises SQL summary.", + "properties": { + "sqlInstances": { + "type": "integer", + "format": "int32", + "description": "The number of SQL instances.", + "readOnly": true + }, + "sqlDatabases": { + "type": "integer", + "format": "int32", + "description": "The number of SQL databases.", + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by SQL version.", + "items": { + "$ref": "#/definitions/SqlVersionDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlOnPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesWebAppSummary": { + "type": "object", + "description": "The on premises web application summary.", + "properties": { + "numberOfWebServers": { + "type": "integer", + "format": "int32", + "description": "The number of web servers.", + "readOnly": true + }, + "numberOfWebApplications": { + "type": "integer", + "format": "int32", + "description": "The number of web applications.", + "readOnly": true + }, + "numberOfWebAppsPerType": { + "type": "object", + "description": "The number of web applications per web application type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "OptimizationLogic": { + "type": "string", + "enum": [ + "MinimizeCost", + "ModernizeToPaaS", + "ModernizeToAzureSqlMi", + "ModernizeToAzureSqlDb" + ], + "x-ms-enum": { + "name": "OptimizationLogic", + "modelAsString": true + } + }, + "OptionsArmPropertiesBase": { + "type": "object", + "description": "Base ARM model of ARM properties for assessment options.", + "properties": { + "edges": { + "type": "object", + "description": "Gets the mapping of Assessment Options in graph representation.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfStringArray" + }, + "readOnly": true + } + }, + "required": [ + "edges" + ] + }, + "OsLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "OsLicense", + "modelAsString": true + } + }, + "OtherManagementCostsSettings": { + "type": "object", + "description": "Other Management Costs Settings.", + "properties": { + "monitoringCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Monitoring Cost Per Server Per Year." + }, + "patchingCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Patching Cost Per Server Per Year." + }, + "dataProtectionCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Data Protection Cost Per Server Per Year." + } + }, + "required": [ + "monitoringCostPerServerPerYear", + "patchingCostPerServerPerYear", + "dataProtectionCostPerServerPerYear" + ] + }, + "OverviewSummary": { + "type": "object", + "description": "Overview summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/OverviewSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OverviewSummaryListResult": { + "type": "object", + "description": "The response of a OverviewSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OverviewSummary items on this page", + "items": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OverviewSummaryProperties": { + "type": "object", + "description": "Overview summary properties class.", + "properties": { + "totalAzureCost": { + "type": "number", + "format": "float", + "description": "The total Azure cost..", + "readOnly": true + }, + "totalAzureIaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure IaaS cost.", + "readOnly": true + }, + "totalAzurePaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure PaaS cost.", + "readOnly": true + }, + "totalAzureAvsCost": { + "type": "number", + "format": "float", + "description": "The total Avs cost.", + "readOnly": true + }, + "windowsAhubSavings": { + "type": "number", + "format": "float", + "description": "The windows ahub saving.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux ahub saving.", + "readOnly": true + }, + "sqlAhubSavings": { + "type": "number", + "format": "float", + "description": "The sql ahub saving.", + "readOnly": true + }, + "totalOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The total on premises cost.", + "readOnly": true + }, + "esuSavingsFor4years": { + "type": "number", + "format": "float", + "description": "ESU Savings 4 Years.", + "readOnly": true + }, + "managementCostSavings": { + "type": "number", + "format": "float", + "description": "The management cost saving.", + "readOnly": true + }, + "securityCostSavings": { + "type": "number", + "format": "float", + "description": "The security cost saving.", + "readOnly": true + }, + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "serversDiscovered": { + "$ref": "#/definitions/ServersDiscovered", + "description": "Shows the discovered servers by virtualization platform.", + "readOnly": true + }, + "utilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "iaasOsDistribution": { + "$ref": "#/definitions/IaasOsDistribution", + "description": "Shows the infrastructure as a service machine OS distribution.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "paasDistribution": { + "$ref": "#/definitions/PaasDistribution", + "description": "Shows the distribution of platforms.", + "readOnly": true + }, + "azureArcEnabledOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The total Azure arc enabled on-premises cost assuming all on-premises infra is arc enabled.", + "readOnly": true + }, + "futureCostIncludingAzureArc": { + "type": "number", + "format": "float", + "description": "The final cost including azure and azure arc enabled on-premises considering the remaining on-prem infra is arc enabled.", + "readOnly": true + }, + "futureEsuSavingsFor4YearsIncludingAzureArc": { + "type": "number", + "format": "float", + "description": "ESU Savings in 4 Years considering the remaining on-prem infra each year is arc enabled.", + "readOnly": true + }, + "futureManagementCostSavingsIncludingAzureArc": { + "type": "number", + "format": "float", + "description": "The management cost saving considering the remaining on-prem infra is arc enabled", + "readOnly": true + }, + "futureSecurityCostSavingsIncludingAzureArc": { + "type": "number", + "format": "float", + "description": "The security cost saving considering the remaining on-prem infra is arc enabled.", + "readOnly": true + }, + "azureArcServicesCost": { + "type": "number", + "format": "float", + "description": "The total cost of services offered by azure arc.", + "readOnly": true + }, + "futureAzureIaasCost": { + "type": "number", + "format": "float", + "description": "The Iaas component of the future azure cost based on the final migration percentage.", + "readOnly": true + }, + "futureAzurePaasCost": { + "type": "number", + "format": "float", + "description": "The Paas component of the future azure cost based on the final migration percentage.", + "readOnly": true + }, + "futureAzureArcEnabledOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The future azure arc cost based on the final migration percentage.", + "readOnly": true + }, + "futureAzureArcServicesCost": { + "type": "number", + "format": "float", + "description": "The total cost of services offered by azure arc based on the final migration percentage.", + "readOnly": true + } + } + }, + "POSAzurePricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Unknown", + "Standard" + ], + "x-ms-enum": { + "name": "POSAzurePricingTier", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + } + ] + } + }, + "PaasDistribution": { + "type": "object", + "description": "Shows the distribution of platforms.", + "properties": { + "sqlServers": { + "type": "integer", + "format": "int32", + "description": "Number of SQL Server machines.", + "readOnly": true + }, + "iisWebServers": { + "type": "integer", + "format": "int32", + "description": "Number of IIS Web servers.", + "readOnly": true + }, + "webAppDistribution": { + "type": "object", + "description": "Distribution of webapps for each target type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "PaasSummary": { + "type": "object", + "description": "Paas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PaasSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PaasSummaryListResult": { + "type": "object", + "description": "The response of a PaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PaasSummary items on this page", + "items": { + "$ref": "#/definitions/PaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PaasSummaryProperties": { + "type": "object", + "description": "Paas summary properties class.", + "properties": { + "azure": { + "$ref": "#/definitions/AzurePaasSummary", + "description": "Shows the PaaS Azure summary.", + "readOnly": true + }, + "onPremises": { + "$ref": "#/definitions/OnPremisesPaasSummary", + "description": "Shows platform as a service (PaaS) summary.", + "readOnly": true + } + } + }, + "Percentile": { + "type": "string", + "description": "Percentile for Performance Data.", + "enum": [ + "Percentile50", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "x-ms-enum": { + "name": "Percentile", + "modelAsString": true, + "values": [ + { + "name": "Percentile50", + "value": "Percentile50", + "description": "Percentile 50." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "Percentile 90." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "Percentile 95." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "Percentile 99." + } + ] + } + }, + "PerfDataSettings": { + "type": "object", + "description": "Data model of Performance Data Settings.", + "properties": { + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Gets perf data time range." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data start time." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data end time." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Gets percentile utilization for performance data." + } + }, + "required": [ + "timeRange", + "percentile" + ] + }, + "PricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "PricingTier", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + }, + { + "name": "Free", + "value": "Free", + "description": "Free Pricing Tier." + } + ] + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private link resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProcessorInfo": { + "type": "object", + "description": "Represents a information \\ details of a processor.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name \\ model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "Class to represent the Product Support Status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "Gets or sets current version of ServicePack.", + "readOnly": true + }, + "servicePackStatus": { + "type": "string", + "description": "Gets or sets ServicePack of the product.", + "readOnly": true + }, + "esuStatus": { + "type": "string", + "description": "Gets or sets the Extended Security Update ESU status.", + "readOnly": true + }, + "supportStatus": { + "type": "string", + "description": "Gets or sets the support status of the product.", + "readOnly": true + }, + "eta": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ETA.", + "readOnly": true + }, + "currentEsuYear": { + "type": "string", + "description": "Gets or sets the current ESU support year.", + "readOnly": true + }, + "mainstreamEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the main stream end date of the product.", + "readOnly": true + }, + "extendedSupportEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended support end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear1EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 1 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear2EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 2 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear3EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 3 end date of the product.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Properties of a project.", + "properties": { + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was last updated. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint at which the collector agent can call agent REST API.", + "readOnly": true + }, + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "privateEndpointConnections": { + "type": "array", + "description": "The list of private endpoint connections to the project.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "ProjectStatus": { + "type": "string", + "description": "Project Status.", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ProjectStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Active Status." + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Inactive Status." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + } + }, + "ProvisioningState2": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState2", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + }, + "readOnly": true + }, + "ProvisioningStatus": { + "type": "string", + "description": "Provisioning Status.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in Progress." + } + ] + }, + "readOnly": true + }, + "Readiness": { + "type": "string", + "description": "Readiness for Azure.", + "enum": [ + "Unknown", + "NotReady", + "ReadyWithConditions", + "Ready" + ], + "x-ms-enum": { + "name": "Readiness", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Readiness." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Not Ready." + }, + { + "name": "ReadyWithConditions", + "value": "ReadyWithConditions", + "description": "Ready with conditions." + }, + { + "name": "Ready", + "value": "Ready", + "description": "Ready for migration." + } + ] + } + }, + "RecommendationResult": { + "type": "object", + "description": "Data model of Recommendation Result.", + "properties": { + "request": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory request.", + "readOnly": true + }, + "limit": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory limit.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "nodePoolId": { + "type": "string", + "description": "Gets node pool id.", + "readOnly": true + }, + "nodePoolName": { + "type": "string", + "description": "Gets node pool name.", + "readOnly": true + }, + "nodePoolArmSkuName": { + "type": "string", + "description": "Gets node pool arm sku name.", + "readOnly": true + }, + "approxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "request", + "limit", + "osType", + "clusterName", + "nodePoolId", + "nodePoolName", + "nodePoolArmSkuName", + "approxMonthlyCost" + ] + }, + "RecommendedAvsNodeTypeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "avsNodeType": { + "type": "string", + "description": "AVS node type.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Number of nodes.", + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level for the Node.", + "readOnly": true + } + } + }, + "RecommendedSuitability": { + "type": "string", + "enum": [ + "Unknown", + "SuitableForSqlDB", + "SuitableForSqlMI", + "SuitableForVM", + "PotentiallySuitableForVM", + "ReadinessUnknown", + "NotSuitable", + "SuitableForSqlVM", + "ConditionallySuitableForSqlDB", + "ConditionallySuitableForSqlMI", + "ConditionallySuitableForVM", + "ConditionallySuitableForSqlVM" + ], + "x-ms-enum": { + "name": "RecommendedSuitability", + "modelAsString": true + } + }, + "RecommendedVmFamilySummary": { + "type": "object", + "description": "The recommended VM family summary.", + "properties": { + "azureVmFamily": { + "type": "string", + "description": "The Azure VM family.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "The number of machines.", + "readOnly": true + } + } + }, + "RecordOfInt": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "RecordOfStringArray": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "ReportDetails": { + "type": "object", + "description": "Business case report details.", + "properties": { + "reportType": { + "$ref": "#/definitions/ReportType", + "description": "Report type.", + "readOnly": true + }, + "reportStatus": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + } + } + }, + "ReportDownloadUrl": { + "type": "object", + "description": "Download URL for assessment report.", + "properties": { + "businessCaseReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + } + }, + "ReportStatus": { + "type": "string", + "description": "Business case supported report status types.", + "enum": [ + "Unknown", + "None", + "InProgress", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "ReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Status." + }, + { + "name": "None", + "value": "None", + "description": "None Report Status." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress Report Status." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Report Status." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed Report Status." + } + ] + } + }, + "ReportType": { + "type": "string", + "description": "Business case supported report types.", + "enum": [ + "Unknown", + "Excel" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Type." + }, + { + "name": "Excel", + "value": "Excel", + "description": "Excel Report Type." + } + ] + } + }, + "ResourceId": { + "type": "object", + "description": "ARM id for a resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the relative URL to get to this REST resource.", + "readOnly": true + } + } + }, + "SavingsOption": { + "type": "string", + "description": "Business case supported Savings Option types.", + "enum": [ + "Unknown", + "RI3Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "SavingsOption", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Savings Option." + }, + { + "name": "RI3Year", + "value": "RI3Year", + "description": "Reserved Instance 3 Year." + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year", + "description": "Azure Savings Plan 3 Year." + } + ] + } + }, + "SavingsOptions": { + "type": "string", + "description": "Savings Options for Azure.", + "enum": [ + "None", + "OneYearSavings", + "ThreeYearsSavings", + "OneYearReserved", + "ThreeYearsReserved" + ], + "x-ms-enum": { + "name": "SavingsOptions", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Savings Options is not applicable." + }, + { + "name": "OneYearSavings", + "value": "OneYearSavings", + "description": "One Year Savings Plan." + }, + { + "name": "ThreeYearsSavings", + "value": "ThreeYearsSavings", + "description": "Three Years Savings Plan." + }, + { + "name": "OneYearReserved", + "value": "OneYearReserved", + "description": "One Year Reserved Instances." + }, + { + "name": "ThreeYearsReserved", + "value": "ThreeYearsReserved", + "description": "Three Years Reserved Instances." + } + ] + } + }, + "SecuritySettings": { + "type": "object", + "description": "Security settings.", + "properties": { + "serverSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Physical servers per administrator." + }, + "sqlServerSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Virtual machines per administrator." + } + }, + "required": [ + "serverSecurityCostPerServerPerYear", + "sqlServerSecurityCostPerServerPerYear" + ] + }, + "ServerCollector": { + "type": "object", + "description": "Physical server collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ServerCollectorListResult": { + "type": "object", + "description": "The response of a ServerCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerCollector items on this page", + "items": { + "$ref": "#/definitions/ServerCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServersDiscovered": { + "type": "object", + "description": "Shows the discovered servers by virtualization platform.", + "properties": { + "vmWare": { + "type": "integer", + "format": "int32", + "description": "Number of servers on VMWare.", + "readOnly": true + }, + "hyperV": { + "type": "integer", + "format": "int32", + "description": "Number of servers on HyperV.", + "readOnly": true + }, + "physical": { + "type": "integer", + "format": "int32", + "description": "Number of physical servers.", + "readOnly": true + }, + "notApplicable": { + "type": "integer", + "format": "int32", + "description": "Number of servers whose virtualization is unknown.", + "readOnly": true + } + } + }, + "ServicePackInsight": { + "type": "object", + "description": "Service Pack Insight.", + "properties": { + "unknownServicePack": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "patched": { + "type": "integer", + "format": "int32", + "description": "Patched Service Pack Insight.", + "readOnly": true + }, + "unpatched": { + "type": "integer", + "format": "int32", + "description": "Unpatched Service Pack Insight.", + "readOnly": true + } + } + }, + "Settings": { + "type": "object", + "description": "Business case settings.", + "properties": { + "azureSettings": { + "$ref": "#/definitions/AzureSettings", + "description": "Azure settings for a business case." + }, + "onPremiseSettings": { + "$ref": "#/definitions/OnPremiseSettings", + "description": "On-premise settings." + }, + "azureArcSettings": { + "$ref": "#/definitions/AzureArcSettings", + "description": "Azure arc settings." + } + }, + "required": [ + "azureSettings" + ] + }, + "SharedResourcesDTO": { + "type": "object", + "description": "Shared Resources.", + "properties": { + "sharedDataDisks": { + "type": "array", + "description": "Gets the list of shared data disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedLogDisks": { + "type": "array", + "description": "Gets the list of shared log disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedTempDbDisks": { + "type": "array", + "description": "Gets the list of shared Temporary database disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMounts": { + "type": "integer", + "format": "int32", + "description": "Gets number of mounts of shared disks.", + "readOnly": true + }, + "quorumWitness": { + "$ref": "#/definitions/AzureQuorumWitnessDTO", + "description": "Gets quorum witness.", + "readOnly": true + } + } + }, + "SkuReplicationMode": { + "type": "string", + "enum": [ + "NotApplicable", + "ActiveGeoReplication", + "FailoverGroupInstance" + ], + "x-ms-enum": { + "name": "SkuReplicationMode", + "modelAsString": true + } + }, + "SqlAssessedNetworkAdapter": { + "type": "object", + "description": "SQL Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "SqlAssessmentMigrationIssue": { + "type": "object", + "description": "Class representing the SQL migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets the issue id.", + "readOnly": true + }, + "issueCategory": { + "$ref": "#/definitions/SqlAssessmentMigrationIssueCategory", + "description": "Gets the issue category.", + "readOnly": true + }, + "impactedObjects": { + "type": "array", + "description": "Gets the list of impacted objects.", + "items": { + "$ref": "#/definitions/ImpactedAssessmentObject" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentMigrationIssueCategory": { + "type": "string", + "enum": [ + "Issue", + "Warning", + "Internal" + ], + "x-ms-enum": { + "name": "SqlAssessmentMigrationIssueCategory", + "modelAsString": true + } + }, + "SqlAssessmentOptions": { + "type": "object", + "description": "SQL Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a SqlAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentOptionsProperties": { + "type": "object", + "description": "SQL Assessment options properties Web model object.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Gets the list of VM families.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "Gets the Reserved Instance VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "Gets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "Gets or sets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocationsForPaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for PAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocationsForIaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "sqlSkus": { + "type": "array", + "description": "Gets or sets the list of SQL target SKU properties for dropdowns.", + "items": { + "$ref": "#/definitions/SqlPaaSTargetOptions" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSqlTargets": { + "type": "array", + "description": "Gets or sets the Reserved Instance SQL target types.", + "items": { + "$ref": "#/definitions/TargetType" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "supportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for SQL assessments.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2IaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL IAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO", + "description": "Gets the azure SQL IAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL IAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2ListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2PaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL PAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO", + "description": "Gets the azure SQL PAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL PAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2Properties": { + "type": "object", + "description": "SQL assessment properties class.", + "properties": { + "osLicense": { + "$ref": "#/definitions/OsLicense", + "description": "Gets or sets user configurable setting to display the azure hybrid use benefit." + }, + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (SQL, VMs) are up in the\non-premises environment." + }, + "optimizationLogic": { + "$ref": "#/definitions/OptimizationLogic", + "description": "Gets or sets SQL optimization logic." + }, + "reservedInstanceForVm": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets azure reserved instance for VM." + }, + "azureOfferCodeForVm": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Gets or sets Azure Offer Code for VM." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "azureSqlManagedInstanceSettings": { + "$ref": "#/definitions/SqlMiSettings", + "description": "Gets or sets user configurable SQL managed instance settings." + }, + "azureSqlDatabaseSettings": { + "$ref": "#/definitions/SqlDbSettings", + "description": "Gets or sets user configurable SQL database settings." + }, + "azureSqlVmSettings": { + "$ref": "#/definitions/SqlVmSettings", + "description": "Gets or sets user configurable SQL VM settings." + }, + "multiSubnetIntent": { + "$ref": "#/definitions/MultiSubnetIntent", + "description": "Gets or sets user preference indicating intent of multi-subnet configuration." + }, + "asyncCommitModeIntent": { + "$ref": "#/definitions/AsyncCommitModeIntent", + "description": "Gets or sets user preference indicating intent of async commit mode." + }, + "isInternetAccessAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether internet access is available." + }, + "disasterRecoveryLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Gets or sets the Azure Location or Azure region where to which the machines\nwill be migrated." + }, + "enableHadrAssessment": { + "type": "boolean", + "description": "Gets or sets a value indicating whether HADR assessments needs to be created." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "sqlServerLicense": { + "$ref": "#/definitions/SqlServerLicense", + "description": "SQL server license." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "SqlAssessmentV2Summary": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlAssessmentV2SummaryData": { + "type": "object", + "description": "SQL Assessment V2 summary data.", + "properties": { + "suitabilitySummary": { + "type": "object", + "description": "Sql assessment summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Monthly compute cost", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost", + "readOnly": true + }, + "monthlyLicenseCost": { + "type": "number", + "format": "float", + "description": "Monthly license cost", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence Rating", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security cost", + "readOnly": true + } + } + }, + "SqlAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2SummaryProperties": { + "type": "object", + "description": "SQL Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the Assessment summary.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryData" + }, + "readOnly": true + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql version.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql edition.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "instanceDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the instance distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "databaseDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the database distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "numberOfSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSuccessfullyDiscoveredSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of successfully discovered sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlDatabases": { + "type": "integer", + "format": "int32", + "description": "Number of sql databases part of the assessment.", + "readOnly": true + }, + "numberOfFciInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql failover cluster instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlAvailabilityGroups": { + "type": "integer", + "format": "int32", + "description": "Number of sql availability groups part of the assessment.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupDataOverview": { + "type": "object", + "description": "Assessed Sql Availability Group Data Overview.", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "Gets the availability group id." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets the availability group name." + }, + "sqlAvailabilityGroupSdsArmId": { + "type": "string", + "description": "Gets the availability group arm id." + }, + "sqlAvailabilityGroupEntityId": { + "type": "string", + "description": "Gets the availability group entity id." + }, + "sqlAvailabilityReplicaId": { + "type": "string", + "description": "Gets the availability replica id." + } + } + }, + "SqlAvailabilityReplicaSummary": { + "type": "object", + "description": "Assessed Sql Availability Replica Summary.", + "properties": { + "numberOfSynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous read replicas." + }, + "numberOfSynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous non read replicas." + }, + "numberOfAsynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous read replicas." + }, + "numberOfAsynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous non read replicas." + }, + "numberOfPrimaryReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of primary replicas." + } + } + }, + "SqlCollector": { + "type": "object", + "description": "The SQL collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SqlCollectorListResult": { + "type": "object", + "description": "The response of a SqlCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlCollector items on this page", + "items": { + "$ref": "#/definitions/SqlCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDbSettings": { + "type": "object", + "description": "SQL database assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlDataBaseType": { + "$ref": "#/definitions/AzureSqlDataBaseType", + "description": "Gets or sets the azure PAAS SQL instance type." + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the azure SQL compute tier." + }, + "azureSqlPurchaseModel": { + "$ref": "#/definitions/AzureSqlPurchaseModel", + "description": "Gets or sets the azure SQL purchase model." + } + } + }, + "SqlFCIMetadata": { + "type": "object", + "description": "Sql fci meta data.", + "properties": { + "state": { + "$ref": "#/definitions/SqlFCIMetadataState", + "description": "Gets the Sql fci meta data state." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets whether fci is multi subnet." + }, + "fciSharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets the fci shared disk count." + } + } + }, + "SqlFCIMetadataState": { + "type": "string", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "SqlFCIMetadataState", + "modelAsString": true + } + }, + "SqlFCIState": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Passive", + "NotApplicable" + ], + "x-ms-enum": { + "name": "SqlFCIState", + "modelAsString": true + } + }, + "SqlMiSettings": { + "type": "object", + "description": "SQL managed instance assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlInstanceType": { + "$ref": "#/definitions/AzureSqlInstanceType", + "description": "Gets or sets the azure PAAS SQL instance type." + } + } + }, + "SqlMigrationGuideline": { + "type": "object", + "description": "Sql Migration Guideline.", + "properties": { + "guidelineId": { + "type": "string", + "description": "Gets the guideline id." + }, + "migrationGuidelineCategory": { + "$ref": "#/definitions/SqlMigrationGuidelineCategory", + "description": "Gets the migration guideline category." + }, + "migrationGuidelineContext": { + "type": "array", + "description": "Gets the migration guideline context.", + "items": { + "$ref": "#/definitions/MigrationGuidelineContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlMigrationGuidelineCategory": { + "type": "string", + "enum": [ + "Unknown", + "General", + "FailoverCluterInstanceGuideLine", + "AvailabilityGroupGuideline" + ], + "x-ms-enum": { + "name": "SqlMigrationGuidelineCategory", + "modelAsString": true + } + }, + "SqlPaaSTargetOptions": { + "type": "object", + "description": "SQL target options.", + "properties": { + "computeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the Azure SQL compute tier." + }, + "hardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets or sets the Azure SQL hardware generation." + }, + "targetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the Azure SQL target type." + }, + "serviceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the Azure SQL service tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoning": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning.", + "properties": { + "reasoningId": { + "type": "string", + "description": "Gets the reasoning id." + }, + "reasoningString": { + "type": "string", + "description": "Gets the reasoning status." + }, + "reasoningCategory": { + "type": "string", + "description": "Gets the reasoning category." + }, + "contextParameters": { + "type": "array", + "description": "Gets the Sql recommended reasoning parameters.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoningContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoningContext": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "SqlServerLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "SqlServerLicense", + "modelAsString": true + } + }, + "SqlServerLicenseType": { + "type": "string", + "description": "Business case supported SQL Server License types.", + "enum": [ + "Unknown", + "Enterprise", + "Standard" + ], + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Sql Server License." + }, + { + "name": "Enterprise", + "value": "Enterprise", + "description": "Enterprise Sql Server License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Sql Server License." + } + ] + } + }, + "SqlServerLicensingSettings": { + "type": "object", + "description": "SQL Server licensing settings.", + "properties": { + "version": { + "$ref": "#/definitions/SqlServerLicenseType", + "description": "SQL Server version." + }, + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + } + }, + "required": [ + "version", + "licenseCost", + "softwareAssuranceCost" + ] + }, + "SqlServiceTier": { + "type": "object", + "description": "The SQL service tier.", + "properties": { + "serviceTierName": { + "type": "string", + "description": "The service tier name.", + "readOnly": true + }, + "serviceTierNumber": { + "type": "number", + "format": "float", + "description": "The number of sql entities with this tier.", + "readOnly": true + } + } + }, + "SqlVersionDetails": { + "type": "object", + "description": "The SQL version details.", + "properties": { + "sqlVersion": { + "type": "string", + "description": "The SQL version.", + "readOnly": true + }, + "numberOfInstances": { + "type": "integer", + "format": "int32", + "description": "Number of instances with the above SQL version.", + "readOnly": true + } + } + }, + "SqlVmSettings": { + "type": "object", + "description": "SQL VM assessment settings.", + "properties": { + "instanceSeries": { + "type": "array", + "description": "Gets or sets the Azure VM families (calling instance series to keep it\nconsistent with other targets).", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + } + } + }, + "StorageSettings": { + "type": "object", + "description": "Storage settings.", + "properties": { + "costPerGbPerMonth": { + "type": "number", + "format": "float", + "description": "Cost per gigabyte per month." + }, + "maintainanceCostPercentageToAcquisitionCost": { + "type": "number", + "format": "float", + "description": "Maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "costPerGbPerMonth", + "maintainanceCostPercentageToAcquisitionCost" + ] + }, + "SuggestedMigrationTool": { + "type": "string", + "description": "Suggested Migration Tool for Azure.", + "enum": [ + "None", + "WebAppMigration", + "ServerMigration" + ], + "x-ms-enum": { + "name": "SuggestedMigrationTool", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No Migration Tool is suggested." + }, + { + "name": "WebAppMigration", + "value": "WebAppMigration", + "description": "Web App Migration." + }, + { + "name": "ServerMigration", + "value": "ServerMigration", + "description": "Server Migration." + } + ] + } + }, + "Suitability": { + "type": "string", + "description": "Suitability for Azure.", + "enum": [ + "NotSuitable", + "Suitable" + ], + "x-ms-enum": { + "name": "Suitability", + "modelAsString": true, + "values": [ + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + } + ] + } + }, + "SuitabilityResult": { + "type": "object", + "description": "Data model of Suitability Result.", + "properties": { + "readiness": { + "$ref": "#/definitions/Readiness", + "description": "Gets readiness.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/Suitability", + "description": "Gets suitability.", + "readOnly": true + }, + "failedChecks": { + "type": "array", + "description": "Gets list of failed Checks.", + "items": { + "$ref": "#/definitions/Check" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "suggestedMigrationTool": { + "$ref": "#/definitions/SuggestedMigrationTool", + "description": "Gets suggested migration tool.", + "readOnly": true + } + }, + "required": [ + "readiness", + "suitability", + "failedChecks", + "suggestedMigrationTool" + ] + }, + "SummaryDetails": { + "type": "object", + "description": "Data model of Summary Details.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Gets count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "count", + "monthlyCost" + ] + }, + "SummaryPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment Summary ARM properties.", + "properties": { + "assessmentName": { + "type": "string", + "description": "Gets the assessment name.", + "readOnly": true + }, + "summaryName": { + "type": "string", + "description": "Gets the summary name.", + "readOnly": true + }, + "suitabilityPerTarget": { + "type": "object", + "description": "Gets the cloud suitability summary for all entities in the assessment per target.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfInt" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Gets the confidence score.", + "readOnly": true + } + }, + "required": [ + "assessmentName", + "summaryName", + "suitabilityPerTarget", + "monthlyComputeCost", + "monthlyStorageCost", + "confidenceScore" + ] + }, + "SupportStatusDistribution": { + "type": "object", + "description": "Support Status Distribution.", + "properties": { + "unknownSupport": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "mainStream": { + "type": "integer", + "format": "int32", + "description": "Mainstream support.", + "readOnly": true + }, + "extended": { + "type": "integer", + "format": "int32", + "description": "Extended support.", + "readOnly": true + }, + "outOfSupport": { + "type": "integer", + "format": "int32", + "description": "Out of support.", + "readOnly": true + } + } + }, + "SupportabilityStatus": { + "type": "string", + "description": "Supportability Status.", + "enum": [ + "Unknown", + "Mainstream", + "Extended", + "OutOfSupport" + ], + "x-ms-enum": { + "name": "SupportabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Supportability Status." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream Supportability Status." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended Supportability Status." + }, + { + "name": "OutOfSupport", + "value": "OutOfSupport", + "description": "OutOfSupport Supportability Status." + } + ] + } + }, + "TargetSpecificResult": { + "type": "object", + "description": "Target specific result.", + "properties": { + "assessmentResult": { + "$ref": "#/definitions/AssessmentResult", + "description": "Gets or sets the assessment result." + }, + "migrationIssues": { + "type": "array", + "description": "Gets or sets the web app migration issues.", + "items": { + "$ref": "#/definitions/WebAppMigrationIssues" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "assessmentResult", + "migrationIssues" + ] + }, + "TargetSpecificSummary": { + "type": "object", + "description": "Web app target specific summary data.", + "properties": { + "readinessSummary": { + "type": "object", + "description": "Web app readiness summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "recommendationResultSkuDetails": { + "type": "object", + "description": "Web app recommendation sku details data", + "additionalProperties": { + "$ref": "#/definitions/WebAppSkuDetails" + }, + "readOnly": true + } + } + }, + "TargetType": { + "type": "string", + "enum": [ + "Unknown", + "Recommended", + "AzureSqlDatabase", + "AzureSqlManagedInstance", + "AzureSqlVirtualMachine", + "AzureVirtualMachine" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true + } + }, + "ThirdPartyManagementSettings": { + "type": "object", + "description": "Third Party Management settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "License Cost." + }, + "supportCost": { + "type": "number", + "format": "float", + "description": "Support Cost." + } + }, + "required": [ + "licenseCost", + "supportCost" + ] + }, + "TimeRange": { + "type": "string", + "description": "Time Range for Performance Data.", + "enum": [ + "Day", + "Week", + "Month", + "Custom" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true, + "values": [ + { + "name": "Day", + "value": "Day", + "description": "Daily." + }, + { + "name": "Week", + "value": "Week", + "description": "Weekly." + }, + { + "name": "Month", + "value": "Month", + "description": "Monthly." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom Time Range." + } + ] + } + }, + "UltraDiskAssessmentOptions": { + "type": "object", + "description": "Assessment options for Ultra disk type.", + "properties": { + "familyName": { + "type": "string", + "description": "Family name." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where ultra disk is supported for this VMfamily.", + "items": { + "type": "string" + } + } + } + }, + "UpdateGroupBody": { + "type": "object", + "description": "Properties of group update.", + "properties": { + "eTag": { + "type": "string", + "description": "For optimistic concurrency control." + }, + "properties": { + "$ref": "#/definitions/GroupBodyProperties", + "description": "Properties of the group." + } + } + }, + "UtilizationData": { + "type": "object", + "description": "The SQL on premises utilization insights.", + "properties": { + "numberOfActiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of active entities.", + "readOnly": true + }, + "numberOfInactiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of inactive entities.", + "readOnly": true + }, + "numberOfDecommisionEntities": { + "type": "integer", + "format": "int32", + "description": "The number of decommission entities.", + "readOnly": true + }, + "numberOfUnknownEntities": { + "type": "integer", + "format": "int32", + "description": "The number of unknown entities.", + "readOnly": true + } + } + }, + "VirtualizationSoftwareSettings": { + "type": "object", + "description": "Virtualization software settings.", + "properties": { + "vMwareCloudFoundationLicenseCost": { + "type": "number", + "format": "float", + "description": "VMware cloud foundation license cost." + } + }, + "required": [ + "vMwareCloudFoundationLicenseCost" + ] + }, + "VmFamilyOptions": { + "type": "object", + "description": "VM family name, the list of targeted azure locations and the category of the\nfamily.", + "properties": { + "familyName": { + "type": "string", + "description": "Name of the VM family.", + "readOnly": true + }, + "targetLocations": { + "type": "array", + "description": "List of Azure regions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "category": { + "type": "array", + "description": "Category of the VM family.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "VmUptime": { + "type": "object", + "description": "Details on the total up-time for the VM.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Number of days in a month for VM uptime." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Number of hours per day for VM uptime." + } + } + }, + "VmwareCollector": { + "type": "object", + "description": "VMware collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VmwareCollectorListResult": { + "type": "object", + "description": "The response of a VmwareCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareCollector items on this page", + "items": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VsphereLicense": { + "type": "object", + "description": "Representation of a vsphere licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereLicenseBase": { + "type": "object", + "description": "Representation of a vsphere licence base.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "basicSupportCost": { + "type": "number", + "format": "float", + "description": "Basic support cost." + }, + "productionSupportCost": { + "type": "number", + "format": "float", + "description": "Production support cost." + } + }, + "required": [ + "licenseCost", + "basicSupportCost", + "productionSupportCost" + ] + }, + "VsphereManagementLicense": { + "type": "object", + "description": "Representation of a vsphere management licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/VsphereManagementLicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereManagementLicenseType": { + "type": "string", + "description": "Business case supported Vsphere Management License types.", + "enum": [ + "Unknown", + "VSphereServerStandard" + ], + "x-ms-enum": { + "name": "VsphereManagementLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereServerStandard", + "value": "VSphereServerStandard", + "description": "VSphereServerStandard License." + } + ] + } + }, + "VsphereManagementSettings": { + "type": "object", + "description": "Vsphere management settings.", + "properties": { + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereManagementLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "licenseAndSupportList" + ] + }, + "WebApp": { + "type": "object", + "description": "Data model of Web App.", + "properties": { + "discoveryArmId": { + "type": "string", + "description": "Gets discovery arm id.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets display name.", + "readOnly": true + }, + "webServerArmId": { + "type": "string", + "description": "Gets web server arm id.", + "readOnly": true + }, + "webServerDisplayName": { + "type": "string", + "description": "Gets web server display name.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Gets machine arm id.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets machine display name.", + "readOnly": true + }, + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets web app type.", + "readOnly": true + } + }, + "required": [ + "discoveryArmId", + "displayName", + "webServerArmId", + "webServerDisplayName", + "machineArmId", + "machineDisplayName", + "webAppType" + ] + }, + "WebAppAssessmentOptions": { + "type": "object", + "description": "Web app Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentOptionsProperties": { + "type": "object", + "description": "Web app Assessment options properties Web model object.", + "properties": { + "webAppSkus": { + "type": "array", + "description": "Gets the list of web app target options.", + "items": { + "$ref": "#/definitions/WebAppTargetOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppAssessmentV2": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2ListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2Properties": { + "type": "object", + "description": "Web app assessment properties class.", + "properties": { + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (Web app, VMs) are up in the\non-premises environment." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "appSvcNativeSettings": { + "$ref": "#/definitions/AppSvcNativeSettings", + "description": "Gets or sets user configurable app service native settings." + }, + "appSvcContainerSettings": { + "$ref": "#/definitions/AppSvcContainerSettings", + "description": "Gets or sets user configurable app service container database settings." + }, + "discoveredEntityLightSummary": { + "$ref": "#/definitions/DiscoveredEntityLightSummary", + "description": "Gets or sets user configurable discovered entity settings." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppAssessmentV2Summary": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2SummaryProperties": { + "type": "object", + "description": "Web app Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the discovered entities summary.", + "additionalProperties": { + "$ref": "#/definitions/DiscoveredEntitiesSummary" + }, + "readOnly": true + }, + "targetSpecificSummary": { + "type": "object", + "description": "Gets the target specific summary.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificSummary" + }, + "readOnly": true + } + } + }, + "WebAppCollector": { + "type": "object", + "description": "The web app collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppCollectorPropertiesBaseWithAgent", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppCollectorListResult": { + "type": "object", + "description": "The response of a WebAppCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppCollector items on this page", + "items": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppCollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppDistribution": { + "type": "object", + "description": "The app type distribution.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppTypes", + "description": "WebApp type.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + } + } + }, + "WebAppMigrationIssues": { + "type": "object", + "description": "Web app migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets or sets the issue Id." + }, + "issueCategory": { + "$ref": "#/definitions/AzureWebAppSuitabilityIssueCategory", + "description": "Gets or sets the issue category." + }, + "issueDescriptionList": { + "type": "array", + "description": "Gets or sets the issue description list.", + "items": { + "type": "string" + } + } + }, + "required": [ + "issueId", + "issueCategory", + "issueDescriptionList" + ] + }, + "WebAppServicePlanV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppServicePlanV2Properties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "WebAppServicePlanV2ListResult": { + "type": "object", + "description": "The response of a WebAppServicePlanV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppServicePlanV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppServicePlanV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "webAppTargetType": { + "$ref": "#/definitions/AzureWebAppTargetType", + "description": "Gets or sets the target specific result.", + "readOnly": true + }, + "webAppServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets the machine name.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "double", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "scaleOutInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "ram": { + "type": "number", + "format": "double", + "description": "Machine arm id.", + "readOnly": true + }, + "webAppSkuName": { + "type": "string", + "description": "Web app sku name.", + "readOnly": true + }, + "webAppSkuSize": { + "type": "string", + "description": "Web app sku size.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "webAppServicePlanName", + "numberOfWebApps" + ] + }, + "WebAppSkuDetails": { + "type": "object", + "description": "Web app sku details.", + "properties": { + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security data", + "readOnly": true + }, + "skuName": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "skuSize": { + "type": "string", + "description": "Sku size", + "readOnly": true + }, + "appServicePlanCount": { + "type": "integer", + "format": "int32", + "description": "App service plan count", + "readOnly": true + } + }, + "required": [ + "skuName", + "skuSize", + "appServicePlanCount" + ] + }, + "WebAppTargetOptions": { + "type": "object", + "description": "Web app target options.", + "properties": { + "webAppTier": { + "$ref": "#/definitions/AzureWebAppTier", + "description": "Gets or sets the Azure web app tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppTargetSku": { + "type": "object", + "description": "The Webapp target SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans or node pools recommended.", + "readOnly": true + } + } + }, + "WebAppType": { + "type": "string", + "description": "Web App Type.", + "enum": [ + "Unknown", + "IIS", + "Tomcat" + ], + "x-ms-enum": { + "name": "WebAppType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates Missing Data." + }, + { + "name": "IIS", + "value": "IIS", + "description": "ASP.NET Web App." + }, + { + "name": "Tomcat", + "value": "Tomcat", + "description": "Java Web App." + } + ] + } + }, + "WebAppTypes": { + "type": "string", + "description": "Business case supported WebApp types.", + "enum": [ + "Unknown", + "ASPNET", + "Java" + ], + "x-ms-enum": { + "name": "WebAppTypes", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown WebApp Type." + }, + { + "name": "ASPNET", + "value": "ASPNET", + "description": "ASPNET Type." + }, + { + "name": "Java", + "value": "Java", + "description": "Java Tomcat Type." + } + ] + } + }, + "WindowsServerLicensingSettings": { + "type": "object", + "description": "Windows Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + }, + "licensesPerCore": { + "type": "integer", + "format": "int32", + "description": "Licenses per core." + } + }, + "required": [ + "licenseCost", + "softwareAssuranceCost", + "licensesPerCore" + ] + }, + "LinuxServerLicensingSettings": { + "type": "object", + "description": "Linux Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + } + }, + "required": [ + "licenseCost" + ] + }, + "WorkloadSummary": { + "type": "object", + "description": "Workload summary.", + "properties": { + "oracleInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + }, + "springApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + } + } + }, + "Year": { + "type": "string", + "description": "Year values.", + "enum": [ + "Year0", + "Year1", + "Year2", + "Year3" + ], + "x-ms-enum": { + "name": "Year", + "modelAsString": true, + "values": [ + { + "name": "Year0", + "value": "Year0", + "description": "Year 0." + }, + { + "name": "Year1", + "value": "Year1", + "description": "Year 1." + }, + { + "name": "Year2", + "value": "Year2", + "description": "Year 2." + }, + { + "name": "Year3", + "value": "Year3", + "description": "Year 3." + } + ] + } + }, + "YearOnYearCost": { + "type": "object", + "description": "Year on Year cost.", + "properties": { + "year": { + "$ref": "#/definitions/Year", + "description": "Year value." + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost for the specified year." + } + }, + "required": [ + "year" + ] + }, + "YearOnYearEstimates": { + "type": "object", + "description": "Shows the year-on-year cost overall.", + "properties": { + "onPremisesCost": { + "type": "object", + "description": "Year-on-Year on-premises cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCost": { + "type": "object", + "description": "Year-on-Year Azure cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "savings": { + "type": "object", + "description": "Year-on-Year savings.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesCapexCost": { + "type": "object", + "description": "Year-on-Year on-premises capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesOpexCost": { + "type": "object", + "description": "Year-on-Year on-premises opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCapexCost": { + "type": "object", + "description": "Year-on-Year azure capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureOpexCost": { + "type": "object", + "description": "Year-on-Year azure opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "paybackPeriod": { + "type": "integer", + "format": "int32", + "description": "Payback period.", + "readOnly": true + }, + "azureArcEnabledOnPremisesCost": { + "type": "array", + "description": "Year-on-Year azure arc enabled on-premises cost.", + "items": { + "$ref": "#/definitions/YearOnYearCost" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "futureCost": { + "type": "array", + "description": "Year-on-Year azure with arc enabled on-premises cost.", + "items": { + "$ref": "#/definitions/YearOnYearCost" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "futureAzureArcEnabledOnPremisesEsuCost": { + "type": "array", + "description": "Year-on-Year azure arc enabled on-premises esu cost of the remaining infra on-premises.", + "items": { + "$ref": "#/definitions/YearOnYearCost" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "futureOnPremisesEsuCost": { + "type": "array", + "description": "Year-on-Year on-premises esu cost of the remaining infra on-premises.", + "items": { + "$ref": "#/definitions/YearOnYearCost" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md index 6cc346e85d39..9c32da1dc6ba 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/readme.md @@ -26,7 +26,23 @@ These are the global settings for the API. ``` yaml openapi-type: arm -tag: package-preview-2023-09 +tag: package-preview-2024-01 +``` + +### Tag: package-preview-2024-01 + +These settings apply only when `--tag=package-preview-2024-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-01' +input-file: + - preview/2024-01-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. ``` ### Tag: package-preview-2023-09 From db8e7d36f32fe94549f581bbeae1aa2857f4ca2a Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Tue, 28 Jan 2025 11:44:43 -0800 Subject: [PATCH 56/74] Add fallback user id lookup for test resource deployment (#32362) Co-authored-by: Ben Broderick Phillips --- eng/common/TestResources/New-TestResources.ps1 | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/eng/common/TestResources/New-TestResources.ps1 b/eng/common/TestResources/New-TestResources.ps1 index 8a61b68c6b2e..2c1308505954 100644 --- a/eng/common/TestResources/New-TestResources.ps1 +++ b/eng/common/TestResources/New-TestResources.ps1 @@ -320,8 +320,14 @@ try { # Make sure the provisioner OID is set so we can pass it through to the deployment. if (!$ProvisionerApplicationId -and !$ProvisionerApplicationOid) { if ($context.Account.Type -eq 'User') { - # Use -Mail as the lookup works in both corp and TME tenants + # Support corp tenant and TME tenant user id lookups $user = Get-AzADUser -Mail $context.Account.Id + if ($user -eq $null -or !$user.Id) { + $user = Get-AzADUser -UserPrincipalName $context.Account.Id + } + if ($user -eq $null -or !$user.Id) { + throw "Failed to find entra object ID for the current user" + } $ProvisionerApplicationOid = $user.Id } elseif ($context.Account.Type -eq 'ServicePrincipal') { $sp = Get-AzADServicePrincipal -ApplicationId $context.Account.Id @@ -391,8 +397,14 @@ try { Write-Warning "The specified TestApplicationId '$TestApplicationId' will be ignored when -ServicePrincipalAutth is not set." } - # Use -Mail as the lookup works in both corp and TME tenants + # Support corp tenant and TME tenant user id lookups $userAccount = (Get-AzADUser -Mail (Get-AzContext).Account.Id) + if ($userAccount -eq $null -or !$userAccount.Id) { + $userAccount = (Get-AzADUser -UserPrincipalName (Get-AzContext).Account) + } + if ($userAccount -eq $null -or !$userAccount.Id) { + throw "Failed to find entra object ID for the current user" + } $TestApplicationOid = $userAccount.Id $TestApplicationId = $testApplicationOid $userAccountName = $userAccount.UserPrincipalName From 5e5d8196f6ba69545a9c4882ab4769d108b513c9 Mon Sep 17 00:00:00 2001 From: Jonny Eskew Date: Tue, 28 Jan 2025 17:48:59 -0500 Subject: [PATCH 57/74] Re-model preflight response to avoid breaking change in .NET SDK (#32255) * Re-model preflight response to avoid breaking change in .NET SDK * Add examples for 400 responses to preflight * Add 'id', 'name', and 'type' properties to preflight response model to reflect API beavhior * Update Microsoft.Resources readme files * Add back removed readme configs to clear Swagger Avocado error --- .../stable/2024-07-01/resources.json | 47 +++++++++---- ...stDeploymentValidateOnManagementGroup.json | 25 +++++++ ...PostDeploymentValidateOnResourceGroup.json | 25 +++++++ .../PostDeploymentValidateOnScope.json | 25 +++++++ .../PostDeploymentValidateOnSubscription.json | 25 +++++++ .../PostDeploymentValidateOnTenant.json | 25 +++++++ .../stable/2024-11-01/resources.json | 69 +++++++++++++++++-- .../resources/resource-manager/readme.md | 4 +- .../resource-manager/readme.python.md | 10 +-- 9 files changed, 230 insertions(+), 25 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-07-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-07-01/resources.json index 76f549c2b3b6..707bea4ee614 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-07-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-07-01/resources.json @@ -283,7 +283,7 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { @@ -292,7 +292,7 @@ "400": { "description": "The template deployment validation detected failures.", "schema": { - "$ref": "#/definitions/DeploymentValidationError" + "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { @@ -593,7 +593,7 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { @@ -602,7 +602,7 @@ "400": { "description": "The template deployment validation detected failures.", "schema": { - "$ref": "#/definitions/DeploymentValidationError" + "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { @@ -977,7 +977,7 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { @@ -986,7 +986,7 @@ "400": { "description": "The template deployment validation detected failures.", "schema": { - "$ref": "#/definitions/DeploymentValidationError" + "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { @@ -1370,7 +1370,7 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { @@ -1379,7 +1379,7 @@ "400": { "description": "The template deployment validation detected failures.", "schema": { - "$ref": "#/definitions/DeploymentValidationError" + "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { @@ -1832,7 +1832,7 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { @@ -1841,7 +1841,7 @@ "400": { "description": "The template deployment validation detected failures.", "schema": { - "$ref": "#/definitions/DeploymentValidationError" + "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { @@ -5521,13 +5521,34 @@ }, "description": "Deployment on error behavior with additional details." }, - "DeploymentValidationError": { + "DeploymentValidateResult": { "properties": { "error": { - "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail" + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The deployment validation error." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the deployment." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the deployment." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "The template deployment properties." } }, - "description": "The template deployment validation detected failures." + "description": "Information from validate template deployment response." }, "DeploymentExtended": { "properties": { diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnManagementGroup.json index e2e226a0561c..d494963295f2 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnManagementGroup.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnManagementGroup.json @@ -75,6 +75,31 @@ "headers": { "Location": "/providers/Microsoft.Resources/operationResults/XXXXXXXXXXXXXXX?api-version=2024-11-01" } + }, + "400": { + "headers": { + "x-ms-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0", + "x-ms-correlation-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0" + }, + "body": { + "error": { + "code": "InvalidTemplateDeployment", + "message": "The template deployment 'my-deployment' is not valid according to the validation procedure. The tracking id is 'dccf336d-c3ee-4057-a902-9efc0e023cd0'. See inner errors for details.", + "details": [ + { + "code": "PreflightValidationCheckFailed", + "message": "Preflight validation failed. Please refer to the details for the specific errors.", + "details": [ + { + "code": "AccountNameInvalid", + "target": "a", + "message": "a is not a valid storage account name. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only." + } + ] + } + ] + } + } } } } diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnResourceGroup.json index 7fe924dc02fe..76ec196642b8 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnResourceGroup.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnResourceGroup.json @@ -76,6 +76,31 @@ "headers": { "Location": "/subscriptions/00000000-0000-0000-0000-000000000001/operationResults/XXXXXXXXXXXXXXX?api-version=2024-11-01" } + }, + "400": { + "headers": { + "x-ms-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0", + "x-ms-correlation-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0" + }, + "body": { + "error": { + "code": "InvalidTemplateDeployment", + "message": "The template deployment 'my-deployment' is not valid according to the validation procedure. The tracking id is 'dccf336d-c3ee-4057-a902-9efc0e023cd0'. See inner errors for details.", + "details": [ + { + "code": "PreflightValidationCheckFailed", + "message": "Preflight validation failed. Please refer to the details for the specific errors.", + "details": [ + { + "code": "AccountNameInvalid", + "target": "a", + "message": "a is not a valid storage account name. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only." + } + ] + } + ] + } + } } } } diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnScope.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnScope.json index b2ac839abaa5..e7e06a2b2eb8 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnScope.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnScope.json @@ -75,6 +75,31 @@ "headers": { "Location": "/subscriptions/00000000-0000-0000-0000-000000000001/operationResults/XXXXXXXXXXXXXXX?api-version=2024-11-01" } + }, + "400": { + "headers": { + "x-ms-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0", + "x-ms-correlation-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0" + }, + "body": { + "error": { + "code": "InvalidTemplateDeployment", + "message": "The template deployment 'my-deployment' is not valid according to the validation procedure. The tracking id is 'dccf336d-c3ee-4057-a902-9efc0e023cd0'. See inner errors for details.", + "details": [ + { + "code": "PreflightValidationCheckFailed", + "message": "Preflight validation failed. Please refer to the details for the specific errors.", + "details": [ + { + "code": "AccountNameInvalid", + "target": "a", + "message": "a is not a valid storage account name. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only." + } + ] + } + ] + } + } } } } diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnSubscription.json index 183f24c46555..f04ed58a0f64 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnSubscription.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnSubscription.json @@ -75,6 +75,31 @@ "headers": { "Location": "/subscriptions/00000000-0000-0000-0000-000000000001/operationResults/XXXXXXXXXXXXXXX?api-version=2024-11-01" } + }, + "400": { + "headers": { + "x-ms-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0", + "x-ms-correlation-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0" + }, + "body": { + "error": { + "code": "InvalidTemplateDeployment", + "message": "The template deployment 'my-deployment' is not valid according to the validation procedure. The tracking id is 'dccf336d-c3ee-4057-a902-9efc0e023cd0'. See inner errors for details.", + "details": [ + { + "code": "PreflightValidationCheckFailed", + "message": "Preflight validation failed. Please refer to the details for the specific errors.", + "details": [ + { + "code": "AccountNameInvalid", + "target": "a", + "message": "a is not a valid storage account name. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only." + } + ] + } + ] + } + } } } } diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnTenant.json index ac60096111c4..1f7cd19eec45 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnTenant.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/examples/PostDeploymentValidateOnTenant.json @@ -74,6 +74,31 @@ "headers": { "Location": "/providers/Microsoft.Resources/operationResults/XXXXXXXXXXXXXXX?api-version=2024-11-01" } + }, + "400": { + "headers": { + "x-ms-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0", + "x-ms-correlation-request-id": "dccf336d-c3ee-4057-a902-9efc0e023cd0" + }, + "body": { + "error": { + "code": "InvalidTemplateDeployment", + "message": "The template deployment 'my-deployment' is not valid according to the validation procedure. The tracking id is 'dccf336d-c3ee-4057-a902-9efc0e023cd0'. See inner errors for details.", + "details": [ + { + "code": "PreflightValidationCheckFailed", + "message": "Preflight validation failed. Please refer to the details for the specific errors.", + "details": [ + { + "code": "AccountNameInvalid", + "target": "a", + "message": "a is not a valid storage account name. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only." + } + ] + } + ] + } + } } } } diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/resources.json index 54919851a1bd..c15865047e99 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2024-11-01/resources.json @@ -283,12 +283,18 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." }, + "400": { + "description": "The template deployment validation detected failures.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -587,12 +593,18 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." }, + "400": { + "description": "The template deployment validation detected failures.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -965,12 +977,18 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." }, + "400": { + "description": "The template deployment validation detected failures.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -1352,12 +1370,18 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." }, + "400": { + "description": "The template deployment validation detected failures.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -1808,12 +1832,18 @@ "200": { "description": "The template deployment validation succeeded. Please inspect 'warnings' property since some resources might have been skipped from validation.", "schema": { - "$ref": "#/definitions/DeploymentExtended" + "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." }, + "400": { + "description": "The template deployment validation detected failures.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -5499,6 +5529,35 @@ }, "description": "Deployment on error behavior with additional details." }, + "DeploymentValidateResult": { + "properties": { + "error": { + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The deployment validation error." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the deployment." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the deployment." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "The template deployment properties." + } + }, + "description": "Information from validate template deployment response." + }, "DeploymentExtended": { "properties": { "id": { diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 7cb5ab487355..a91a7215a859 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -1314,7 +1314,7 @@ directive: reason: The resource is managed in a management group level (instead of inside a resource group) - suppress: TopLevelResourcesListBySubscription from: changes.json - reason: We will be pushing customers to use Azure Resource Graph for those at scale scenarios. + reason: We will be pushing customers to use Azure Resource Graph for those at scale scenarios. - from: changes.json suppress: OperationsAPIImplementation where: $.paths @@ -1325,7 +1325,7 @@ directive: reason: 'Duplicate Operations API causes generation issues' - suppress: TopLevelResourcesListBySubscription from: snapshots.json - reason: We will be pushing customers to use Azure Resource Graph for those at scale scenarios. + reason: We will be pushing customers to use Azure Resource Graph for those at scale scenarios. - suppress: RequiredReadOnlySystemData from: changes.json reason: System Metadata from a change resource perspective is irrelevant diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index f764e8feb889..cb4006ede88b 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -461,14 +461,14 @@ namespace: azure.mgmt.resource.policy.v2015_10_01_preview output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/policy/v2015_10_01_preview ``` -### Tag: package-resources-2024-07 and python +### Tag: package-resources-2024-11 and python -These settings apply only when `--tag=package-resources-2024-07 --python` is specified on the command line. +These settings apply only when `--tag=package-resources-2024-11 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-resources-2024-07' -default-api-version: "2024-07-01" -namespace: azure.mgmt.resource.resources.v2024_07_01 +``` yaml $(tag) == 'package-resources-2024-11' +default-api-version: "2024-11-01" +namespace: azure.mgmt.resource.resources.v2024_11_01 output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2024_07_01 ``` From c24c5a514435bfbc251da0233e548a0ffb4543e0 Mon Sep 17 00:00:00 2001 From: wenlu-mwc Date: Tue, 28 Jan 2025 18:54:55 -0800 Subject: [PATCH 58/74] Add fabric usage API to a preview version (#32204) * list usage * result as enumeration * fix example * remove supress * add quota name * fix client * code style prettier * compile * add a new preview version * fix example * clean * update version in examples * fix format * fix type * fix type * remove id * recompile * pageable extension * update readme --- .../Microsoft.Fabric.Management/capacity.tsp | 11 + .../Microsoft.Fabric.Management/client.tsp | 1 + ...abricCapacities_CheckNameAvailability.json | 20 + .../FabricCapacities_CreateOrUpdate.json | 85 ++ .../FabricCapacities_Delete.json | 19 + .../FabricCapacities_Get.json | 35 + .../FabricCapacities_ListByResourceGroup.json | 59 + .../FabricCapacities_ListBySubscription.json | 58 + .../FabricCapacities_ListSkus.json | 44 + .../FabricCapacities_ListSkusForCapacity.json | 95 ++ ...icCapacities_ListUsagesBySubscription.json | 26 + .../FabricCapacities_Resume.json | 19 + .../FabricCapacities_Suspend.json | 19 + .../FabricCapacities_Update.json | 58 + .../2025-01-15-preview/Operations_List.json | 65 + .../Microsoft.Fabric.Management/main.tsp | 4 +- .../Microsoft.Fabric.Management/models.tsp | 29 +- ...abricCapacities_CheckNameAvailability.json | 20 + .../FabricCapacities_CreateOrUpdate.json | 85 ++ .../examples/FabricCapacities_Delete.json | 19 + .../examples/FabricCapacities_Get.json | 35 + .../FabricCapacities_ListByResourceGroup.json | 59 + .../FabricCapacities_ListBySubscription.json | 58 + .../examples/FabricCapacities_ListSkus.json | 44 + .../FabricCapacities_ListSkusForCapacity.json | 95 ++ ...icCapacities_ListUsagesBySubscription.json | 26 + .../examples/FabricCapacities_Resume.json | 19 + .../examples/FabricCapacities_Suspend.json | 19 + .../examples/FabricCapacities_Update.json | 58 + .../examples/Operations_List.json | 65 + .../preview/2025-01-15-preview/fabric.json | 1209 +++++++++++++++++ .../fabric/resource-manager/readme.md | 14 + 32 files changed, 2468 insertions(+), 4 deletions(-) create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CheckNameAvailability.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CreateOrUpdate.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Delete.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Get.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListByResourceGroup.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListBySubscription.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkus.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkusForCapacity.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListUsagesBySubscription.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Resume.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Suspend.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Update.json create mode 100644 specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/Operations_List.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CheckNameAvailability.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CreateOrUpdate.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Delete.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Get.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListByResourceGroup.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListBySubscription.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkus.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkusForCapacity.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListUsagesBySubscription.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Resume.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Suspend.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Update.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/Operations_List.json create mode 100644 specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/fabric.json diff --git a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp index bb2cb0bc77b9..5aea05b0c457 100644 --- a/specification/fabric/Microsoft.Fabric.Management/capacity.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/capacity.tsp @@ -85,4 +85,15 @@ interface FabricCapacities { ...SubscriptionIdParameter, ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, ): RpSkuEnumerationForNewResourceResult | ErrorResponse; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "" + @get + @doc("List the current consumption and limit in this location for the provided subscription") + @segment("usages") + listUsages( + ...ApiVersionParameter, + ...SubscriptionIdParameter, + ...Azure.ResourceManager.Foundations.DefaultProviderNamespace, + ...LocationParameter, + ): ArmResponse> | ErrorResponse; } diff --git a/specification/fabric/Microsoft.Fabric.Management/client.tsp b/specification/fabric/Microsoft.Fabric.Management/client.tsp index 11fdd48ada33..dda1a84171ea 100644 --- a/specification/fabric/Microsoft.Fabric.Management/client.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/client.tsp @@ -46,6 +46,7 @@ namespace Microsoft.Fabric { "FabricCapacityAdministration", "csharp" ); + @@clientName(Quota, "FabricQuota", "csharp"); } @@clientName(Microsoft.Fabric, "FabricMgmtClient", "python"); diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CheckNameAvailability.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CheckNameAvailability.json new file mode 100644 index 000000000000..fdbf2e1d3e21 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Check name availability of a capacity", + "operationId": "FabricCapacities_CheckNameAvailability", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "location": "westcentralus", + "body": { + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CreateOrUpdate.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CreateOrUpdate.json new file mode 100644 index 000000000000..73950081bed6 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "title": "Create or update a capacity", + "operationId": "FabricCapacities_CreateOrUpdate", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "resource": { + "properties": { + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "state": "Preparing", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Delete.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Delete.json new file mode 100644 index 000000000000..1b21feaf3493 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete a capacity", + "operationId": "FabricCapacities_Delete", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } + }, + "204": {} + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Get.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Get.json new file mode 100644 index 000000000000..9dea3b586db9 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Get.json @@ -0,0 +1,35 @@ +{ + "title": "Get a capacity", + "operationId": "FabricCapacities_Get", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListByResourceGroup.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListByResourceGroup.json new file mode 100644 index 000000000000..3746ec2808d7 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "List capacities by resource group", + "operationId": "FabricCapacities_ListByResourceGroup", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListBySubscription.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListBySubscription.json new file mode 100644 index 000000000000..b3ffc3aec6c2 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "List capacities by subscription", + "operationId": "FabricCapacities_ListBySubscription", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkus.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkus.json new file mode 100644 index 000000000000..c517477c6305 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkus.json @@ -0,0 +1,44 @@ +{ + "title": "List eligible SKUs for a new capacity", + "operationId": "FabricCapacities_ListSkus", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "F8", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F64", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F128", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F512", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkusForCapacity.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkusForCapacity.json new file mode 100644 index 000000000000..b38aeb1d41dc --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListSkusForCapacity.json @@ -0,0 +1,95 @@ +{ + "title": "List eligible SKUs for an existing capacity", + "operationId": "FabricCapacities_ListSkusForCapacity", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F16", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F8", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F64", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F1024", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F128", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F256", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F32", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F4", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F512", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2048", + "tier": "Fabric" + } + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListUsagesBySubscription.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListUsagesBySubscription.json new file mode 100644 index 000000000000..2e2739f1f21e --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_ListUsagesBySubscription.json @@ -0,0 +1,26 @@ +{ + "title": "List quota usages for a subscription", + "operationId": "FabricCapacities_ListUsages", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "location": "centraluseuap" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "CapacityQuota", + "localizedValue": "CapacityQuota" + }, + "unit": "CU", + "currentValue": 378, + "limit": 512 + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Resume.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Resume.json new file mode 100644 index 000000000000..ec11c8cb8d1b --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Resume.json @@ -0,0 +1,19 @@ +{ + "title": "Resume capacity", + "operationId": "FabricCapacities_Resume", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Suspend.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Suspend.json new file mode 100644 index 000000000000..c9d7f7a83f8e --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Suspend.json @@ -0,0 +1,19 @@ +{ + "title": "Suspend capacity", + "operationId": "FabricCapacities_Suspend", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Update.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Update.json new file mode 100644 index 000000000000..e1791f439721 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/FabricCapacities_Update.json @@ -0,0 +1,58 @@ +{ + "title": "Update capacity properties", + "operationId": "FabricCapacities_Update", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "properties": { + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "properties": { + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Updating", + "state": "Preparing", + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/Operations_List.json b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/Operations_List.json new file mode 100644 index 000000000000..3d76f021a536 --- /dev/null +++ b/specification/fabric/Microsoft.Fabric.Management/examples/2025-01-15-preview/Operations_List.json @@ -0,0 +1,65 @@ +{ + "title": "List operations", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-01-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Fabric/capacities/read", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Read Fabric Capacity", + "description": "Retrieves the information of the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/write", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Create/Update Fabric Capacity", + "description": "Creates or updates the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/delete", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Delete the Fabric Capacity", + "description": "Deletes the Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/suspend/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Suspend the specified Fabric capacity", + "description": "Suspend the specified Fabric capacity" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/resume/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Resume the specified Fabric capacity", + "description": "Resume the specified Fabric capacity" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/fabric/Microsoft.Fabric.Management/main.tsp b/specification/fabric/Microsoft.Fabric.Management/main.tsp index f8d6e9530c2b..8b1fd65b7070 100644 --- a/specification/fabric/Microsoft.Fabric.Management/main.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/main.tsp @@ -21,9 +21,9 @@ namespace Microsoft.Fabric; /** The available API versions. */ enum Versions { - /** 2023-11-01 version */ + /** 2025-01-15-preview version */ @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_2) @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) - v2023_11_01: "2023-11-01", + v2025_01_15_preview: "2025-01-15-preview", } diff --git a/specification/fabric/Microsoft.Fabric.Management/models.tsp b/specification/fabric/Microsoft.Fabric.Management/models.tsp index 8dca9773a8b0..09a3cf078350 100644 --- a/specification/fabric/Microsoft.Fabric.Management/models.tsp +++ b/specification/fabric/Microsoft.Fabric.Management/models.tsp @@ -115,7 +115,7 @@ model RpSkuEnumerationForNewResourceResult { value: Array; @doc("Url for the next page. Null if no more pages available") - @nextLink + @TypeSpec.nextLink nextLink?: string; } @@ -145,7 +145,7 @@ model RpSkuEnumerationForExistingResourceResult { value: Array; @doc("Url for the next page. Null if no more pages available") - @nextLink + @TypeSpec.nextLink nextLink?: string; } @@ -168,3 +168,28 @@ model CapacityNameParameter { @path capacityName: string; } + +@doc("Describes Resource Quota") +model Quota { + @doc("The name of the quota.") + @visibility("read") + name?: QuotaName; + + @doc("The unit of usage measurement.") + unit: string; + + @doc("The current usage of the resource.") + currentValue: int64; + + @doc("The maximum permitted usage of the resource.") + limit: int64; +} + +@doc("The Quota Names") +model QuotaName { + @doc("The name of the resource.") + value?: string; + + @doc("The localized name of the resource.") + localizedValue?: string; +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CheckNameAvailability.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CheckNameAvailability.json new file mode 100644 index 000000000000..fdbf2e1d3e21 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "title": "Check name availability of a capacity", + "operationId": "FabricCapacities_CheckNameAvailability", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "location": "westcentralus", + "body": { + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CreateOrUpdate.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CreateOrUpdate.json new file mode 100644 index 000000000000..73950081bed6 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "title": "Create or update a capacity", + "operationId": "FabricCapacities_CreateOrUpdate", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "resource": { + "properties": { + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Updating", + "state": "Preparing", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + }, + "body": { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Delete.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Delete.json new file mode 100644 index 000000000000..1b21feaf3493 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete a capacity", + "operationId": "FabricCapacities_Delete", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } + }, + "204": {} + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Get.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Get.json new file mode 100644 index 000000000000..9dea3b586db9 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Get.json @@ -0,0 +1,35 @@ +{ + "title": "Get a capacity", + "operationId": "FabricCapacities_Get", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com", + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListByResourceGroup.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListByResourceGroup.json new file mode 100644 index 000000000000..3746ec2808d7 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "List capacities by resource group", + "operationId": "FabricCapacities_ListByResourceGroup", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListBySubscription.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListBySubscription.json new file mode 100644 index 000000000000..b3ffc3aec6c2 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "List capacities by subscription", + "operationId": "FabricCapacities_ListBySubscription", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "state": "Active", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F2", + "tier": "Fabric" + }, + "tags": {}, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + }, + { + "properties": { + "provisioningState": "Provisioning", + "state": "Provisioning", + "administration": { + "members": [ + "azsdktest@microsoft.com" + ] + } + }, + "sku": { + "name": "F4", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "West Central US", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest2", + "name": "azsdktest2", + "type": "Microsoft.Fabric/capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkus.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkus.json new file mode 100644 index 000000000000..c517477c6305 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkus.json @@ -0,0 +1,44 @@ +{ + "title": "List eligible SKUs for a new capacity", + "operationId": "FabricCapacities_ListSkus", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "F8", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F64", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F128", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + }, + { + "name": "F512", + "locations": [ + "West Europe" + ], + "resourceType": "Capacities" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkusForCapacity.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkusForCapacity.json new file mode 100644 index 000000000000..b38aeb1d41dc --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListSkusForCapacity.json @@ -0,0 +1,95 @@ +{ + "title": "List eligible SKUs for an existing capacity", + "operationId": "FabricCapacities_ListSkusForCapacity", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F16", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F8", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F64", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F1024", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F128", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F256", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F32", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F4", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F512", + "tier": "Fabric" + } + }, + { + "resourceType": "Microsoft.Fabric/capacities", + "sku": { + "name": "F2048", + "tier": "Fabric" + } + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListUsagesBySubscription.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListUsagesBySubscription.json new file mode 100644 index 000000000000..2e2739f1f21e --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_ListUsagesBySubscription.json @@ -0,0 +1,26 @@ +{ + "title": "List quota usages for a subscription", + "operationId": "FabricCapacities_ListUsages", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "location": "centraluseuap" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": { + "value": "CapacityQuota", + "localizedValue": "CapacityQuota" + }, + "unit": "CU", + "currentValue": 378, + "limit": 512 + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Resume.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Resume.json new file mode 100644 index 000000000000..ec11c8cb8d1b --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Resume.json @@ -0,0 +1,19 @@ +{ + "title": "Resume capacity", + "operationId": "FabricCapacities_Resume", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Suspend.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Suspend.json new file mode 100644 index 000000000000..c9d7f7a83f8e --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Suspend.json @@ -0,0 +1,19 @@ +{ + "title": "Suspend capacity", + "operationId": "FabricCapacities_Suspend", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760837928&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/82494E97-958D-4BFF-92F1-297BB0D9F2D7?api-version=2023-11-01&t=638525947760994159&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Update.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Update.json new file mode 100644 index 000000000000..e1791f439721 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/FabricCapacities_Update.json @@ -0,0 +1,58 @@ +{ + "title": "Update capacity properties", + "operationId": "FabricCapacities_Update", + "parameters": { + "api-version": "2025-01-15-preview", + "subscriptionId": "548B7FB7-3B2A-4F46-BB02-66473F1FC22C", + "resourceGroupName": "TestRG", + "capacityName": "azsdktest", + "properties": { + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "properties": { + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Updating", + "state": "Preparing", + "administration": { + "members": [ + "azsdktest2@microsoft.com" + ] + } + }, + "sku": { + "name": "F8", + "tier": "Fabric" + }, + "tags": { + "testKey": "testValue" + }, + "location": "westcentralus", + "id": "/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/resourceGroups/TestRG/providers/Microsoft.Fabric/capacities/azsdktest", + "name": "azsdktest", + "type": "Microsoft.Fabric/capacities" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationresults/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/548B7FB7-3B2A-4F46-BB02-66473F1FC22C/providers/Microsoft.Fabric/locations/westcentralus/operationstatuses/946B9C42-0D6C-4A42-94AE-1156A1EC8534?api-version=2023-11-01&t=638525901413778740&c=MIIH5zCCBs-" + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/Operations_List.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/Operations_List.json new file mode 100644 index 000000000000..3d76f021a536 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/examples/Operations_List.json @@ -0,0 +1,65 @@ +{ + "title": "List operations", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-01-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Fabric/capacities/read", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Read Fabric Capacity", + "description": "Retrieves the information of the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/write", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Create/Update Fabric Capacity", + "description": "Creates or updates the specified Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/delete", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Delete the Fabric Capacity", + "description": "Deletes the Fabric Capacity." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/suspend/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Suspend the specified Fabric capacity", + "description": "Suspend the specified Fabric capacity" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.Fabric/capacities/resume/action", + "display": { + "provider": "Microsoft Fabric", + "resource": "capacities", + "operation": "Resume the specified Fabric capacity", + "description": "Resume the specified Fabric capacity" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/fabric.json b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/fabric.json new file mode 100644 index 000000000000..8e92b593942e --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/preview/2025-01-15-preview/fabric.json @@ -0,0 +1,1209 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Fabric management service", + "version": "2025-01-15-preview", + "description": "Microsoft.Fabric Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "FabricCapacities" + }, + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.Fabric/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/capacities": { + "get": { + "operationId": "FabricCapacities_ListBySubscription", + "tags": [ + "FabricCapacities" + ], + "description": "List FabricCapacity resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List capacities by subscription": { + "$ref": "./examples/FabricCapacities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/locations/{location}/checkNameAvailability": { + "post": { + "operationId": "FabricCapacities_CheckNameAvailability", + "tags": [ + "FabricCapacities" + ], + "description": "Implements local CheckNameAvailability operations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check name availability of a capacity": { + "$ref": "./examples/FabricCapacities_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/locations/{location}/usages": { + "get": { + "operationId": "FabricCapacities_ListUsages", + "tags": [ + "FabricCapacities" + ], + "description": "List the current consumption and limit in this location for the provided subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List quota usages for a subscription": { + "$ref": "./examples/FabricCapacities_ListUsagesBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Fabric/skus": { + "get": { + "operationId": "FabricCapacities_ListSkus", + "tags": [ + "FabricCapacities" + ], + "description": "List eligible SKUs for Microsoft Fabric resource provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RpSkuEnumerationForNewResourceResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List eligible SKUs for a new capacity": { + "$ref": "./examples/FabricCapacities_ListSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities": { + "get": { + "operationId": "FabricCapacities_ListByResourceGroup", + "tags": [ + "FabricCapacities" + ], + "description": "List FabricCapacity resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List capacities by resource group": { + "$ref": "./examples/FabricCapacities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}": { + "get": { + "operationId": "FabricCapacities_Get", + "tags": [ + "FabricCapacities" + ], + "description": "Get a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a capacity": { + "$ref": "./examples/FabricCapacities_Get.json" + } + } + }, + "put": { + "operationId": "FabricCapacities_CreateOrUpdate", + "tags": [ + "FabricCapacities" + ], + "description": "Create a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'FabricCapacity' update operation succeeded", + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "201": { + "description": "Resource 'FabricCapacity' create operation succeeded", + "schema": { + "$ref": "#/definitions/FabricCapacity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a capacity": { + "$ref": "./examples/FabricCapacities_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "FabricCapacities_Update", + "tags": [ + "FabricCapacities" + ], + "description": "Update a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/FabricCapacityUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update capacity properties": { + "$ref": "./examples/FabricCapacities_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "FabricCapacities_Delete", + "tags": [ + "FabricCapacities" + ], + "description": "Delete a FabricCapacity", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a capacity": { + "$ref": "./examples/FabricCapacities_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/resume": { + "post": { + "operationId": "FabricCapacities_Resume", + "tags": [ + "FabricCapacities" + ], + "description": "Resume operation of the specified Fabric capacity instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resume capacity": { + "$ref": "./examples/FabricCapacities_Resume.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/skus": { + "get": { + "operationId": "FabricCapacities_ListSkusForCapacity", + "tags": [ + "FabricCapacities" + ], + "description": "List eligible SKUs for a Microsoft Fabric resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CapacityNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RpSkuEnumerationForExistingResourceResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List eligible SKUs for an existing capacity": { + "$ref": "./examples/FabricCapacities_ListSkusForCapacity.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric/capacities/{capacityName}/suspend": { + "post": { + "operationId": "FabricCapacities_Suspend", + "tags": [ + "FabricCapacities" + ], + "description": "Suspend operation of the specified Fabric capacity instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "capacityName", + "in": "path", + "description": "The name of the Microsoft Fabric capacity. It must be a minimum of 3 characters, and a maximum of 63.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Suspend capacity": { + "$ref": "./examples/FabricCapacities_Suspend.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "CapacityAdministration": { + "type": "object", + "description": "The administration properties of the Fabric capacity resource", + "properties": { + "members": { + "type": "array", + "description": "An array of administrator user identities.", + "items": { + "type": "string" + } + } + }, + "required": [ + "members" + ] + }, + "FabricCapacity": { + "type": "object", + "description": "Fabric Capacity resource", + "properties": { + "properties": { + "$ref": "#/definitions/FabricCapacityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/RpSku", + "description": "The SKU details" + } + }, + "required": [ + "properties", + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "FabricCapacityListResult": { + "type": "object", + "description": "The response of a FabricCapacity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The FabricCapacity items on this page", + "items": { + "$ref": "#/definitions/FabricCapacity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FabricCapacityProperties": { + "type": "object", + "description": "The Microsoft Fabric capacity properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The current deployment state of Microsoft Fabric resource. The provisioningState is to indicate states for resource provisioning.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/ResourceState", + "description": "The current state of Microsoft Fabric resource. The state is to indicate more states outside of resource provisioning.", + "readOnly": true + }, + "administration": { + "$ref": "#/definitions/CapacityAdministration", + "description": "The capacity administration" + } + }, + "required": [ + "administration" + ] + }, + "FabricCapacityUpdate": { + "type": "object", + "description": "The type used for update operations of the FabricCapacity.", + "properties": { + "sku": { + "$ref": "#/definitions/RpSku", + "description": "The SKU details" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/FabricCapacityUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "FabricCapacityUpdateProperties": { + "type": "object", + "description": "The updatable properties of the FabricCapacity.", + "properties": { + "administration": { + "$ref": "#/definitions/CapacityAdministration", + "description": "The capacity administration" + } + } + }, + "PagedQuota": { + "type": "object", + "description": "Paged collection of Quota items", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of the Fabric capacity resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Provisioning", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is deleting" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is provisioning" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is updating" + } + ] + }, + "readOnly": true + }, + "Quota": { + "type": "object", + "description": "Describes Resource Quota", + "properties": { + "name": { + "$ref": "#/definitions/QuotaName", + "description": "The name of the quota.", + "readOnly": true + }, + "unit": { + "type": "string", + "description": "The unit of usage measurement." + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + } + }, + "required": [ + "unit", + "currentValue", + "limit" + ] + }, + "QuotaName": { + "type": "object", + "description": "The Quota Names", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + } + }, + "ResourceState": { + "type": "string", + "description": "The state of the Fabric capacity resource.", + "enum": [ + "Active", + "Provisioning", + "Failed", + "Updating", + "Deleting", + "Suspending", + "Suspended", + "Pausing", + "Paused", + "Resuming", + "Scaling", + "Preparing" + ], + "x-ms-enum": { + "name": "ResourceState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Resource is active" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is provisioning" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource is failed" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is deleting" + }, + { + "name": "Suspending", + "value": "Suspending", + "description": "Resource is suspending" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "Resource is suspended" + }, + { + "name": "Pausing", + "value": "Pausing", + "description": "Resource is pausing" + }, + { + "name": "Paused", + "value": "Paused", + "description": "Resource is paused" + }, + { + "name": "Resuming", + "value": "Resuming", + "description": "Resource is resuming" + }, + { + "name": "Scaling", + "value": "Scaling", + "description": "Resource is scaling" + }, + { + "name": "Preparing", + "value": "Preparing", + "description": "Resource is preparing" + } + ] + } + }, + "RpSku": { + "type": "object", + "description": "Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU level." + }, + "tier": { + "$ref": "#/definitions/RpSkuTier", + "description": "The name of the Azure pricing tier to which the SKU applies." + } + }, + "required": [ + "name", + "tier" + ] + }, + "RpSkuDetailsForExistingResource": { + "type": "object", + "description": "An object that represents SKU details for existing resources", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type" + }, + "sku": { + "$ref": "#/definitions/RpSku", + "description": "The SKU details" + } + }, + "required": [ + "resourceType", + "sku" + ] + }, + "RpSkuDetailsForNewResource": { + "type": "object", + "description": "The SKU details", + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type" + }, + "name": { + "type": "string", + "description": "The SKU's name" + }, + "locations": { + "type": "array", + "description": "The list of available locations for the SKU", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + } + }, + "required": [ + "resourceType", + "name", + "locations" + ] + }, + "RpSkuEnumerationForExistingResourceResult": { + "type": "object", + "description": "An object that represents enumerating SKUs for existing resources", + "properties": { + "value": { + "type": "array", + "description": "The SKU details", + "items": { + "$ref": "#/definitions/RpSkuDetailsForExistingResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Url for the next page. Null if no more pages available" + } + }, + "required": [ + "value" + ] + }, + "RpSkuEnumerationForNewResourceResult": { + "type": "object", + "description": "An object that represents enumerating SKUs for new resources.", + "properties": { + "value": { + "type": "array", + "description": "The collection of available SKUs for new resources", + "items": { + "$ref": "#/definitions/RpSkuDetailsForNewResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Url for the next page. Null if no more pages available" + } + }, + "required": [ + "value" + ] + }, + "RpSkuProperties": { + "type": "object", + "description": "The SKU properties", + "properties": { + "name": { + "type": "string", + "description": "The SKU's name" + }, + "locations": { + "type": "array", + "description": "The list of available locations for the SKU", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + } + }, + "required": [ + "name", + "locations" + ] + }, + "RpSkuTier": { + "type": "string", + "description": "The name of the Azure pricing tier to which the SKU applies.", + "enum": [ + "Fabric" + ], + "x-ms-enum": { + "name": "RpSkuTier", + "modelAsString": true, + "values": [ + { + "name": "fabric", + "value": "Fabric", + "description": "Fabric tier" + } + ] + } + } + }, + "parameters": { + "CapacityNameParameter": { + "name": "capacityName", + "in": "path", + "description": "The name of the capacity.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/fabric/resource-manager/readme.md b/specification/fabric/resource-manager/readme.md index 617d8d2ed09c..f06474383b08 100644 --- a/specification/fabric/resource-manager/readme.md +++ b/specification/fabric/resource-manager/readme.md @@ -48,6 +48,20 @@ suppressions: ``` --- +### Tag: package-2025-01-15-preview + +These settings apply only when `--tag=package-2025-01-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-01-15-preview' +input-file: + - Microsoft.Fabric/preview/2025-01-15-preview/fabric.json +suppressions: + - code: PostResponseCodes + reason: 2 POST Methods Resume and Suspend are LRO and the result returns 200 OK with no schema. It would take a while to fix the backend to return 204. Once fixed, will publish a new version. Specifying only 202 causes failues in the Az CLI Tools generation. + from: fabric.json +``` +--- + # Code Generation ## Swagger to SDK From e66f0d5f60aedb36de3ba2fc8b4f8e3bce8bec34 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 28 Jan 2025 21:00:13 -0800 Subject: [PATCH 59/74] [EngSys] Convert GitHub actions to ESM, add placeholder tests (#32376) - Convert all actions to ESM - Add placeholder tests for actions - Add vitest to package.json - Rename and move update-labels JS --- .../setup-node-install-deps/action.yaml | 37 +++++++++++++++ .github/actions/setup-node-npm-ci/action.yaml | 27 ----------- .github/actions/update-labels/action.yaml | 7 +-- .../{action.js => src/update-labels.js} | 8 ++-- .../update-labels/test/update-labels.test.js | 11 +++++ .github/package.json | 9 +++- .github/{actions => src}/context.js | 12 ++--- .github/test/context.test.js | 9 ++++ .github/workflows/SDK-Suppressions-Label.yaml | 4 +- .../workflows/_reusable-eng-tools-test.yaml | 4 +- .github/workflows/github-test.yaml | 46 +++++++++++++++++++ .github/workflows/typespec-requirement.yaml | 4 +- .../workflows/typespec-validation-all.yaml | 4 +- .github/workflows/typespec-validation.yaml | 4 +- 14 files changed, 134 insertions(+), 52 deletions(-) create mode 100644 .github/actions/setup-node-install-deps/action.yaml delete mode 100644 .github/actions/setup-node-npm-ci/action.yaml rename .github/actions/update-labels/{action.js => src/update-labels.js} (94%) create mode 100644 .github/actions/update-labels/test/update-labels.test.js rename .github/{actions => src}/context.js (96%) create mode 100644 .github/test/context.test.js create mode 100644 .github/workflows/github-test.yaml diff --git a/.github/actions/setup-node-install-deps/action.yaml b/.github/actions/setup-node-install-deps/action.yaml new file mode 100644 index 000000000000..c743ae002085 --- /dev/null +++ b/.github/actions/setup-node-install-deps/action.yaml @@ -0,0 +1,37 @@ +name: Setup Node and install dependencies +description: Uses specified Node version and installs dependencies (typically using "npm") + +inputs: + node-version: + description: 'Node version to use' + default: 22.x + install-command: + description: 'Command to install dependencies' + default: 'npm ci' + working-directory: + description: 'Working directory' + default: '.' + +runs: + using: "composite" + + steps: + - uses: actions/setup-node@v4 + with: + node-version: ${{ inputs.node-version }} + + - run: | + echo "::group::$INSTALL_COMMAND" + $INSTALL_COMMAND + echo "::endgroup::" + shell: bash + env: + INSTALL_COMMAND: ${{ inputs.install-command }} + working-directory: ${{ inputs.working-directory }} + + - run: | + echo "::group::npm ls -a" + npm ls -a || true + echo "::endgroup::" + shell: bash + working-directory: ${{ inputs.working-directory }} diff --git a/.github/actions/setup-node-npm-ci/action.yaml b/.github/actions/setup-node-npm-ci/action.yaml deleted file mode 100644 index 9287062190cf..000000000000 --- a/.github/actions/setup-node-npm-ci/action.yaml +++ /dev/null @@ -1,27 +0,0 @@ -name: Setup Node and run `npm ci` -description: Uses specified Node version and runs npm commands to set up the environment for REST API CI - -inputs: - node-version: - description: 'Node version to use' - default: 22.x - -runs: - using: "composite" - - steps: - - uses: actions/setup-node@v4 - with: - node-version: ${{ inputs.node-version }} - - - run: | - echo "::group::npm ci" - npm ci - echo "::endgroup::" - shell: bash - - - run: | - echo "::group::npm ls -a" - npm ls -a || true - echo "::endgroup::" - shell: bash diff --git a/.github/actions/update-labels/action.yaml b/.github/actions/update-labels/action.yaml index d87902dcba48..c452b7eaf6fb 100644 --- a/.github/actions/update-labels/action.yaml +++ b/.github/actions/update-labels/action.yaml @@ -20,7 +20,7 @@ runs: using: composite steps: - - name: Set Label + - name: Update Labels uses: actions/github-script@v7 env: OWNER: ${{ inputs.owner }} @@ -29,5 +29,6 @@ runs: RUN_ID: ${{ inputs.run_id }} with: script: | - const action = require('./.github/actions/update-labels/action.js') - await action({ github, context, core }); + const { default: updateLabels } = + await import('${{ github.workspace }}/.github/actions/update-labels/src/update-labels.js'); + await updateLabels({ github, context, core }); diff --git a/.github/actions/update-labels/action.js b/.github/actions/update-labels/src/update-labels.js similarity index 94% rename from .github/actions/update-labels/action.js rename to .github/actions/update-labels/src/update-labels.js index ffd734584b14..4e9f36364e54 100644 --- a/.github/actions/update-labels/action.js +++ b/.github/actions/update-labels/src/update-labels.js @@ -1,11 +1,11 @@ // @ts-check -const { extractInputs } = require("../context"); +import { extractInputs } from "../../../src/context.js"; /** * @param {import('github-script').AsyncFunctionArguments} AsyncFunctionArguments */ -module.exports = async ({ github, context, core }) => { +export default async function updateLabels({ github, context, core }) { let owner = process.env.OWNER; let repo = process.env.REPO; let issue_number = parseInt(process.env.ISSUE_NUMBER || ""); @@ -82,7 +82,7 @@ module.exports = async ({ github, context, core }) => { } if (labelsToRemove.length > 0) { - // Must loop over labelsToRemove ourselves, since GitHub doesn't expose a REST API to remove in bulk. + // Must loop over labelsToRemove ourselves, since GitHub doesn't expose a REST API to remove in bulk. for (const name of labelsToRemove) { try { await github.rest.issues.removeLabel({ @@ -100,4 +100,4 @@ module.exports = async ({ github, context, core }) => { } } } -}; +} diff --git a/.github/actions/update-labels/test/update-labels.test.js b/.github/actions/update-labels/test/update-labels.test.js new file mode 100644 index 000000000000..bc6e8bf32165 --- /dev/null +++ b/.github/actions/update-labels/test/update-labels.test.js @@ -0,0 +1,11 @@ +import { describe, expect, it } from "vitest"; +import updateLabels from "../src/update-labels.js"; + +describe("update-labels", () => { + // TODO: Replace with better tests + it("throws if inputs null", async () => { + await expect( + updateLabels({ github: null, context: null, core: null }), + ).rejects.toThrow(); + }); +}); diff --git a/.github/package.json b/.github/package.json index 87598b90e726..febfead671ba 100644 --- a/.github/package.json +++ b/.github/package.json @@ -1,8 +1,15 @@ { + "type": "module", "devDependencies": { "@types/node": "^20.0.0", "@types/github-script": "github:actions/github-script", "@octokit/webhooks-types": "^7.5.1", - "prettier": "^3.3.3" + "@vitest/coverage-v8": "^3.0.2", + "prettier": "^3.3.3", + "vitest": "^3.0.4" + }, + "scripts": { + "test": "vitest", + "test:ci": "vitest run --coverage --reporter=verbose" } } diff --git a/.github/actions/context.js b/.github/src/context.js similarity index 96% rename from .github/actions/context.js rename to .github/src/context.js index 8dce041c2f22..2e5dd048409a 100644 --- a/.github/actions/context.js +++ b/.github/src/context.js @@ -3,13 +3,13 @@ /** * Extracts inputs from context based on event name and properties. * run_id is only defined for "workflow_run:completed" events. - * + * * @param {import('github-script').AsyncFunctionArguments['github']} github * @param {import('github-script').AsyncFunctionArguments['context']} context * @param {import('github-script').AsyncFunctionArguments['core']} core * @returns {Promise<{owner: string, repo: string, head_sha: string, issue_number: number, run_id: number }>} */ -async function extractInputs(github, context, core) { +export async function extractInputs(github, context, core) { core.info(`extractInputs(${context.eventName}, ${context.payload.action})`); // Add support for more event types as needed @@ -24,11 +24,11 @@ async function extractInputs(github, context, core) { repo: payload.repository.name, head_sha: payload.pull_request.head.sha, issue_number: payload.number, - run_id: NaN + run_id: NaN, }; - + core.info(`inputs: ${JSON.stringify(inputs)}`); - + return inputs; } else if ( context.eventName === "workflow_run" && @@ -91,5 +91,3 @@ async function extractInputs(github, context, core) { ); } } - -module.exports = { extractInputs }; diff --git a/.github/test/context.test.js b/.github/test/context.test.js new file mode 100644 index 000000000000..593ab2a18a0e --- /dev/null +++ b/.github/test/context.test.js @@ -0,0 +1,9 @@ +import { describe, expect, it } from "vitest"; +import { extractInputs } from "../src/context.js"; + +describe("context", () => { + // TODO: Replace with better tests + it("throws if inputs null", async () => { + await expect(extractInputs(null, null, null)).rejects.toThrow(); + }); +}); diff --git a/.github/workflows/SDK-Suppressions-Label.yaml b/.github/workflows/SDK-Suppressions-Label.yaml index 47d53d2b05fe..5bb561551d17 100644 --- a/.github/workflows/SDK-Suppressions-Label.yaml +++ b/.github/workflows/SDK-Suppressions-Label.yaml @@ -20,8 +20,8 @@ jobs: # Required since "HEAD^" is passed to Get-ChangedFiles fetch-depth: 2 - - name: Setup Node and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci + - name: Setup Node and install deps + uses: ./.github/actions/setup-node-install-deps - name: Get GitHub PullRequest Changed Files shell: pwsh diff --git a/.github/workflows/_reusable-eng-tools-test.yaml b/.github/workflows/_reusable-eng-tools-test.yaml index 56758dd53fb1..8150b362ec92 100644 --- a/.github/workflows/_reusable-eng-tools-test.yaml +++ b/.github/workflows/_reusable-eng-tools-test.yaml @@ -46,8 +46,8 @@ jobs: eng ${{ inputs.sparse-checkout-paths }} - - name: Setup Node ${{ matrix.node-version }} and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci + - name: Setup Node ${{ matrix.node-version }} and install deps + uses: ./.github/actions/setup-node-install-deps with: node-version: ${{ matrix.node-version }}.x diff --git a/.github/workflows/github-test.yaml b/.github/workflows/github-test.yaml new file mode 100644 index 000000000000..bb4c7b68ceb5 --- /dev/null +++ b/.github/workflows/github-test.yaml @@ -0,0 +1,46 @@ +name: GitHub Actions - Test + +on: + push: + branches: + - main + paths: + - .github/** + pull_request: + paths: + - .github/** + workflow_dispatch: + +defaults: + run: + shell: bash + working-directory: ./.github + +jobs: + test: + runs-on: ubuntu-24.04 + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + sparse-checkout: | + .github + + - name: Setup Node 20 and install deps + uses: ./.github/actions/setup-node-install-deps + with: + # actions/github-script@v7 uses Node 20 + node-version: 20.x + install-command: 'npm install' + working-directory: ./.github + + - name: Run tests + run: npm run test:ci + + - name: Archive code coverage results + uses: actions/upload-artifact@v4 + with: + name: code-coverage-report + path: ./.github/coverage + if-no-files-found: ignore diff --git a/.github/workflows/typespec-requirement.yaml b/.github/workflows/typespec-requirement.yaml index 37a133a79e04..c5c2a2c841e0 100644 --- a/.github/workflows/typespec-requirement.yaml +++ b/.github/workflows/typespec-requirement.yaml @@ -14,8 +14,8 @@ jobs: # Required since "HEAD^" is passed to TypeSpec-Requirement.ps1 fetch-depth: 2 - - name: Setup Node and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci + - name: Setup Node and install deps + uses: ./.github/actions/setup-node-install-deps - run: | eng/scripts/TypeSpec-Requirement.ps1 ` diff --git a/.github/workflows/typespec-validation-all.yaml b/.github/workflows/typespec-validation-all.yaml index f2fff0e2a180..93092ad7d9a7 100644 --- a/.github/workflows/typespec-validation-all.yaml +++ b/.github/workflows/typespec-validation-all.yaml @@ -65,8 +65,8 @@ jobs: # Convert placeholder string 'default' to '', which tells the action to checkout the default ref. ref: ${{ matrix.ref == 'next' && 'typespec-next' || '' }} - - name: Setup Node and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci + - name: Setup Node and install deps + uses: ./.github/actions/setup-node-install-deps - name: Validate All Specs run: | diff --git a/.github/workflows/typespec-validation.yaml b/.github/workflows/typespec-validation.yaml index 53b804d4a00d..99f01422fd28 100644 --- a/.github/workflows/typespec-validation.yaml +++ b/.github/workflows/typespec-validation.yaml @@ -12,8 +12,8 @@ jobs: with: fetch-depth: 2 - - name: Setup Node and run `npm ci` - uses: ./.github/actions/setup-node-npm-ci + - name: Setup Node and install deps + uses: ./.github/actions/setup-node-install-deps - name: Validate Impacted Specs run: | From 655a8383305db3a9e3560e8c4c4343ccb72ed9b7 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 28 Jan 2025 21:27:27 -0800 Subject: [PATCH 60/74] [EngSys] Restore `.github/package-lock.json` (#32381) - Ensures unit tests are repeatable at a given SHA - Improves perf installing deps on dev machine and in CI - Aligns vitest with eng/tools - Configures dependabot for .github/package.json --- .github/dependabot.yml | 78 +- .github/package-lock.json | 2663 ++++++++++++++++++++++++++++ .github/package.json | 2 +- .github/workflows/github-test.yaml | 1 - .gitignore | 1 + 5 files changed, 2709 insertions(+), 36 deletions(-) create mode 100644 .github/package-lock.json diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 048ae07fd431..792406b01c75 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,36 +1,46 @@ version: 2 updates: -- package-ecosystem: "npm" - directories: - - "/" - - "/eng/tools/**" - schedule: - interval: "daily" - ignore: - # Updated manually to align with minimum supported Node version - - dependency-name: "@types/node" - # Updated manually to align with repo microsoft/typespec - - dependency-name: "typescript" - - dependency-name: "prettier" - # Updated manually by the Liftr team - - dependency-name: "@azure-tools/typespec-liftr-base" - # minimatch@9 is the last version to support Node 18 - - dependency-name: "minimatch" - versions: [ ">= 10.0.0"] - groups: - # Ships separately from other typespec packages - typespec-client-generator-cli: - patterns: - - "@azure-tools/typespec-client-generator-cli" - # Ships separately from other typespec packages - openapi-to-typespec: - patterns: - - "@autorest/openapi-to-typespec" - typespec: - patterns: - - "*typespec*" - eslint: - patterns: - - "*eslint*" - # Leave the constraint if the original constraint allows the new version, otherwise, bump the constraint. - versioning-strategy: increase-if-necessary + - package-ecosystem: "npm" + directories: + - "/" + - "/eng/tools/**" + schedule: + interval: "daily" + ignore: + # Updated manually to align with minimum supported Node version + - dependency-name: "@types/node" + # Updated manually to align with repo microsoft/typespec + - dependency-name: "typescript" + - dependency-name: "prettier" + # Updated manually by the Liftr team + - dependency-name: "@azure-tools/typespec-liftr-base" + # minimatch@9 is the last version to support Node 18 + - dependency-name: "minimatch" + versions: [">= 10.0.0"] + groups: + # Ships separately from other typespec packages + typespec-client-generator-cli: + patterns: + - "@azure-tools/typespec-client-generator-cli" + # Ships separately from other typespec packages + openapi-to-typespec: + patterns: + - "@autorest/openapi-to-typespec" + typespec: + patterns: + - "*typespec*" + eslint: + patterns: + - "*eslint*" + # Leave the constraint if the original constraint allows the new version, otherwise, bump the constraint. + versioning-strategy: increase-if-necessary + - package-ecosystem: "npm" + directories: + - "/.github/" + schedule: + interval: "daily" + ignore: + # Updated manually to align with minimum supported Node version + - dependency-name: "@types/node" + # Updated manually to align with repo microsoft/typespec + - dependency-name: "prettier" diff --git a/.github/package-lock.json b/.github/package-lock.json new file mode 100644 index 000000000000..f34508dd23cd --- /dev/null +++ b/.github/package-lock.json @@ -0,0 +1,2663 @@ +{ + "name": ".github", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "devDependencies": { + "@octokit/webhooks-types": "^7.5.1", + "@types/github-script": "github:actions/github-script", + "@types/node": "^20.0.0", + "@vitest/coverage-v8": "^3.0.2", + "prettier": "^3.3.3", + "vitest": "^3.0.2" + } + }, + "node_modules/@actions/core": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz", + "integrity": "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@actions/exec": "^1.1.1", + "@actions/http-client": "^2.0.1" + } + }, + "node_modules/@actions/exec": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-1.1.1.tgz", + "integrity": "sha512-+sCcHHbVdk93a0XT19ECtO/gIXoxvdsgQLzb2fE2/5sIZmWQuluYyjPQtrtTHdU1YzTZ7bAPN4sITq2xi1679w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@actions/io": "^1.0.1" + } + }, + "node_modules/@actions/github": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@actions/github/-/github-6.0.0.tgz", + "integrity": "sha512-alScpSVnYmjNEXboZjarjukQEzgCRmjMv6Xj47fsdnqGS73bjJNDpiiXmp8jr0UZLdUB6d9jW63IcmddUP+l0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@actions/http-client": "^2.2.0", + "@octokit/core": "^5.0.1", + "@octokit/plugin-paginate-rest": "^9.0.0", + "@octokit/plugin-rest-endpoint-methods": "^10.0.0" + } + }, + "node_modules/@actions/glob": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@actions/glob/-/glob-0.4.0.tgz", + "integrity": "sha512-+eKIGFhsFa4EBwaf/GMyzCdWrXWymGXfFmZU3FHQvYS8mPcHtTtZONbkcqqUMzw9mJ/pImEBFET1JNifhqGsAQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@actions/core": "^1.9.1", + "minimatch": "^3.0.4" + } + }, + "node_modules/@actions/http-client": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.2.3.tgz", + "integrity": "sha512-mx8hyJi/hjFvbPokCg4uRd4ZX78t+YyRPtnKWwIl+RzNaVuFpQHfmlGVfsKEJN8LwTCvL+DfVgAM04XaHkm6bA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tunnel": "^0.0.6", + "undici": "^5.25.4" + } + }, + "node_modules/@actions/io": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@actions/io/-/io-1.1.3.tgz", + "integrity": "sha512-wi9JjgKLYS7U/z8PPbco+PvTb/nRWjeoFlJ1Qer83k/3C5PHQi28hiVdeE2kHXmIL99mQFawx8qt/JPjZilJ8Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@ampproject/remapping": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", + "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.25.9.tgz", + "integrity": "sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.25.9.tgz", + "integrity": "sha512-Ed61U6XJc3CVRfkERJWDz4dJwKe7iLmmJsbOGu9wSloNSFttHV0I8g6UAgb7qnK5ly5bGLPd4oXZlxCdANBOWQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.26.7", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.7.tgz", + "integrity": "sha512-kEvgGGgEjRUutvdVvZhbn/BxVt+5VSpwXz1j3WYXQbXDo8KzFOPNG2GQbdAiNq8g6wn1yKk7C/qrke03a84V+w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.26.7" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/types": { + "version": "7.26.7", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.7.tgz", + "integrity": "sha512-t8kDRGrKXyp6+tjUh7hw2RLyclsW4TRoRvRHtSyAX9Bb5ldlFh+90YAYY6awRXrlB4G5G2izNeGySpATlFzmOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.25.9", + "@babel/helper-validator-identifier": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@bcoe/v8-coverage": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", + "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.24.2.tgz", + "integrity": "sha512-thpVCb/rhxE/BnMLQ7GReQLLN8q9qbHmI55F4489/ByVg2aQaQ6kbcLb6FHkocZzQhxc4gx0sCk0tJkKBFzDhA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.24.2.tgz", + "integrity": "sha512-tmwl4hJkCfNHwFB3nBa8z1Uy3ypZpxqxfTQOcHX+xRByyYgunVbZ9MzUUfb0RxaHIMnbHagwAxuTL+tnNM+1/Q==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.24.2.tgz", + "integrity": "sha512-cNLgeqCqV8WxfcTIOeL4OAtSmL8JjcN6m09XIgro1Wi7cF4t/THaWEa7eL5CMoMBdjoHOTh/vwTO/o2TRXIyzg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.24.2.tgz", + "integrity": "sha512-B6Q0YQDqMx9D7rvIcsXfmJfvUYLoP722bgfBlO5cGvNVb5V/+Y7nhBE3mHV9OpxBf4eAS2S68KZztiPaWq4XYw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.24.2.tgz", + "integrity": "sha512-kj3AnYWc+CekmZnS5IPu9D+HWtUI49hbnyqk0FLEJDbzCIQt7hg7ucF1SQAilhtYpIujfaHr6O0UHlzzSPdOeA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.24.2.tgz", + "integrity": "sha512-WeSrmwwHaPkNR5H3yYfowhZcbriGqooyu3zI/3GGpF8AyUdsrrP0X6KumITGA9WOyiJavnGZUwPGvxvwfWPHIA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.24.2.tgz", + "integrity": "sha512-UN8HXjtJ0k/Mj6a9+5u6+2eZ2ERD7Edt1Q9IZiB5UZAIdPnVKDoG7mdTVGhHJIeEml60JteamR3qhsr1r8gXvg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.24.2.tgz", + "integrity": "sha512-TvW7wE/89PYW+IevEJXZ5sF6gJRDY/14hyIGFXdIucxCsbRmLUcjseQu1SyTko+2idmCw94TgyaEZi9HUSOe3Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.24.2.tgz", + "integrity": "sha512-n0WRM/gWIdU29J57hJyUdIsk0WarGd6To0s+Y+LwvlC55wt+GT/OgkwoXCXvIue1i1sSNWblHEig00GBWiJgfA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.24.2.tgz", + "integrity": "sha512-7HnAD6074BW43YvvUmE/35Id9/NB7BeX5EoNkK9obndmZBUk8xmJJeU7DwmUeN7tkysslb2eSl6CTrYz6oEMQg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.24.2.tgz", + "integrity": "sha512-sfv0tGPQhcZOgTKO3oBE9xpHuUqguHvSo4jl+wjnKwFpapx+vUDcawbwPNuBIAYdRAvIDBfZVvXprIj3HA+Ugw==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.24.2.tgz", + "integrity": "sha512-CN9AZr8kEndGooS35ntToZLTQLHEjtVB5n7dl8ZcTZMonJ7CCfStrYhrzF97eAecqVbVJ7APOEe18RPI4KLhwQ==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.24.2.tgz", + "integrity": "sha512-iMkk7qr/wl3exJATwkISxI7kTcmHKE+BlymIAbHO8xanq/TjHaaVThFF6ipWzPHryoFsesNQJPE/3wFJw4+huw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.24.2.tgz", + "integrity": "sha512-shsVrgCZ57Vr2L8mm39kO5PPIb+843FStGt7sGGoqiiWYconSxwTiuswC1VJZLCjNiMLAMh34jg4VSEQb+iEbw==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.24.2.tgz", + "integrity": "sha512-4eSFWnU9Hhd68fW16GD0TINewo1L6dRrB+oLNNbYyMUAeOD2yCK5KXGK1GH4qD/kT+bTEXjsyTCiJGHPZ3eM9Q==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.24.2.tgz", + "integrity": "sha512-S0Bh0A53b0YHL2XEXC20bHLuGMOhFDO6GN4b3YjRLK//Ep3ql3erpNcPlEFed93hsQAjAQDNsvcK+hV90FubSw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.24.2.tgz", + "integrity": "sha512-8Qi4nQcCTbLnK9WoMjdC9NiTG6/E38RNICU6sUNqK0QFxCYgoARqVqxdFmWkdonVsvGqWhmm7MO0jyTqLqwj0Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.24.2.tgz", + "integrity": "sha512-wuLK/VztRRpMt9zyHSazyCVdCXlpHkKm34WUyinD2lzK07FAHTq0KQvZZlXikNWkDGoT6x3TD51jKQ7gMVpopw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.24.2.tgz", + "integrity": "sha512-VefFaQUc4FMmJuAxmIHgUmfNiLXY438XrL4GDNV1Y1H/RW3qow68xTwjZKfj/+Plp9NANmzbH5R40Meudu8mmw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.24.2.tgz", + "integrity": "sha512-YQbi46SBct6iKnszhSvdluqDmxCJA+Pu280Av9WICNwQmMxV7nLRHZfjQzwbPs3jeWnuAhE9Jy0NrnJ12Oz+0A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.24.2.tgz", + "integrity": "sha512-+iDS6zpNM6EnJyWv0bMGLWSWeXGN/HTaF/LXHXHwejGsVi+ooqDfMCCTerNFxEkM3wYVcExkeGXNqshc9iMaOA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.24.2.tgz", + "integrity": "sha512-hTdsW27jcktEvpwNHJU4ZwWFGkz2zRJUz8pvddmXPtXDzVKTTINmlmga3ZzwcuMpUvLw7JkLy9QLKyGpD2Yxig==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.24.2.tgz", + "integrity": "sha512-LihEQ2BBKVFLOC9ZItT9iFprsE9tqjDjnbulhHoFxYQtQfai7qfluVODIYxt1PgdoyQkz23+01rzwNwYfutxUQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.24.2.tgz", + "integrity": "sha512-q+iGUwfs8tncmFC9pcnD5IvRHAzmbwQ3GPS5/ceCyHdjXubwQWI12MKWSNSMYLJMq23/IUCvJMS76PDqXe1fxA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.24.2.tgz", + "integrity": "sha512-7VTgWzgMGvup6aSqDPLiW5zHaxYJGTO4OokMjIlrCtf+VpEL+cXKtCvg723iguPYI5oaUNdS+/V7OU2gvXVWEg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@fastify/busboy": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", + "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14" + } + }, + "node_modules/@isaacs/cliui": { + "version": "8.0.2", + "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", + "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^5.1.2", + "string-width-cjs": "npm:string-width@^4.2.0", + "strip-ansi": "^7.0.1", + "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", + "wrap-ansi": "^8.1.0", + "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@istanbuljs/schema": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", + "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz", + "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/set-array": "^1.2.1", + "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/set-array": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@octokit/auth-token": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-4.0.0.tgz", + "integrity": "sha512-tY/msAuJo6ARbK6SPIxZrPBms3xPbfwBrulZe0Wtr/DIY9lje2HeV1uoebShn6mx7SjCHif6EjMvoREj+gZ+SA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + } + }, + "node_modules/@octokit/core": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/@octokit/core/-/core-5.2.0.tgz", + "integrity": "sha512-1LFfa/qnMQvEOAdzlQymH0ulepxbxnCYAKJZfMci/5XJyIHWgEYnDmgnKakbTh7CH2tFQ5O60oYDvns4i9RAIg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/auth-token": "^4.0.0", + "@octokit/graphql": "^7.1.0", + "@octokit/request": "^8.3.1", + "@octokit/request-error": "^5.1.0", + "@octokit/types": "^13.0.0", + "before-after-hook": "^2.2.0", + "universal-user-agent": "^6.0.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@octokit/endpoint": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-9.0.5.tgz", + "integrity": "sha512-ekqR4/+PCLkEBF6qgj8WqJfvDq65RH85OAgrtnVp1mSxaXF03u2xW/hUdweGS5654IlC0wkNYC18Z50tSYTAFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/types": "^13.1.0", + "universal-user-agent": "^6.0.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@octokit/graphql": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-7.1.0.tgz", + "integrity": "sha512-r+oZUH7aMFui1ypZnAvZmn0KSqAUgE1/tUXIWaqUCa1758ts/Jio84GZuzsvUkme98kv0WFY8//n0J1Z+vsIsQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/request": "^8.3.0", + "@octokit/types": "^13.0.0", + "universal-user-agent": "^6.0.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@octokit/openapi-types": { + "version": "23.0.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-23.0.1.tgz", + "integrity": "sha512-izFjMJ1sir0jn0ldEKhZ7xegCTj/ObmEDlEfpFrx4k/JyZSMRHbO3/rBwgE7f3m2DHt+RrNGIVw4wSmwnm3t/g==", + "dev": true, + "license": "MIT" + }, + "node_modules/@octokit/plugin-paginate-rest": { + "version": "9.2.1", + "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-9.2.1.tgz", + "integrity": "sha512-wfGhE/TAkXZRLjksFXuDZdmGnJQHvtU/joFQdweXUgzo1XwvBCD4o4+75NtFfjfLK5IwLf9vHTfSiU3sLRYpRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/types": "^12.6.0" + }, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "@octokit/core": "5" + } + }, + "node_modules/@octokit/plugin-paginate-rest/node_modules/@octokit/openapi-types": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@octokit/plugin-paginate-rest/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, + "node_modules/@octokit/plugin-request-log": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@octokit/plugin-request-log/-/plugin-request-log-4.0.1.tgz", + "integrity": "sha512-GihNqNpGHorUrO7Qa9JbAl0dbLnqJVrV8OXe2Zm5/Y4wFkZQDfTreBzVmiRfJVfE4mClXdihHnbpyyO9FSX4HA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "@octokit/core": "5" + } + }, + "node_modules/@octokit/plugin-rest-endpoint-methods": { + "version": "10.4.1", + "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-10.4.1.tgz", + "integrity": "sha512-xV1b+ceKV9KytQe3zCVqjg+8GTGfDYwaT1ATU5isiUyVtlVAO3HNdzpS4sr4GBx4hxQ46s7ITtZrAsxG22+rVg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/types": "^12.6.0" + }, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "@octokit/core": "5" + } + }, + "node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/openapi-types": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz", + "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/types": { + "version": "12.6.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz", + "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/openapi-types": "^20.0.0" + } + }, + "node_modules/@octokit/plugin-retry": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@octokit/plugin-retry/-/plugin-retry-6.1.0.tgz", + "integrity": "sha512-WrO3bvq4E1Xh1r2mT9w6SDFg01gFmP81nIG77+p/MqW1JeXXgL++6umim3t6x0Zj5pZm3rXAN+0HEjmmdhIRig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/request-error": "^5.0.0", + "@octokit/types": "^13.0.0", + "bottleneck": "^2.15.3" + }, + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "@octokit/core": "5" + } + }, + "node_modules/@octokit/request": { + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-8.4.0.tgz", + "integrity": "sha512-9Bb014e+m2TgBeEJGEbdplMVWwPmL1FPtggHQRkV+WVsMggPtEkLKPlcVYm/o8xKLkpJ7B+6N8WfQMtDLX2Dpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/endpoint": "^9.0.1", + "@octokit/request-error": "^5.1.0", + "@octokit/types": "^13.1.0", + "universal-user-agent": "^6.0.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@octokit/request-error": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.1.0.tgz", + "integrity": "sha512-GETXfE05J0+7H2STzekpKObFe765O5dlAKUTLNGeH+x47z7JjXHfsHKo5z21D/o/IOZTUEI6nyWyR+bZVP/n5Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/types": "^13.1.0", + "deprecation": "^2.0.0", + "once": "^1.4.0" + }, + "engines": { + "node": ">= 18" + } + }, + "node_modules/@octokit/types": { + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.7.0.tgz", + "integrity": "sha512-BXfRP+3P3IN6fd4uF3SniaHKOO4UXWBfkdR3vA8mIvaoO/wLjGN5qivUtW0QRitBHHMcfC41SLhNVYIZZE+wkA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@octokit/openapi-types": "^23.0.1" + } + }, + "node_modules/@octokit/webhooks-types": { + "version": "7.6.1", + "resolved": "https://registry.npmjs.org/@octokit/webhooks-types/-/webhooks-types-7.6.1.tgz", + "integrity": "sha512-S8u2cJzklBC0FgTwWVLaM8tMrDuDMVE4xiTK4EYXM9GntyvrdbSoxqDQa+Fh57CCNApyIpyeqPhhFEmHPfrXgw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@pkgjs/parseargs": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", + "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", + "dev": true, + "license": "MIT", + "optional": true, + "engines": { + "node": ">=14" + } + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.32.1.tgz", + "integrity": "sha512-/pqA4DmqyCm8u5YIDzIdlLcEmuvxb0v8fZdFhVMszSpDTgbQKdw3/mB3eMUHIbubtJ6F9j+LtmyCnHTEqIHyzA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.32.1.tgz", + "integrity": "sha512-If3PDskT77q7zgqVqYuj7WG3WC08G1kwXGVFi9Jr8nY6eHucREHkfpX79c0ACAjLj3QIWKPJR7w4i+f5EdLH5Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.32.1.tgz", + "integrity": "sha512-zCpKHioQ9KgZToFp5Wvz6zaWbMzYQ2LJHQ+QixDKq52KKrF65ueu6Af4hLlLWHjX1Wf/0G5kSJM9PySW9IrvHA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.32.1.tgz", + "integrity": "sha512-sFvF+t2+TyUo/ZQqUcifrJIgznx58oFZbdHS9TvHq3xhPVL9nOp+yZ6LKrO9GWTP+6DbFtoyLDbjTpR62Mbr3Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.32.1.tgz", + "integrity": "sha512-NbOa+7InvMWRcY9RG+B6kKIMD/FsnQPH0MWUvDlQB1iXnF/UcKSudCXZtv4lW+C276g3w5AxPbfry5rSYvyeYA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.32.1.tgz", + "integrity": "sha512-JRBRmwvHPXR881j2xjry8HZ86wIPK2CcDw0EXchE1UgU0ubWp9nvlT7cZYKc6bkypBt745b4bglf3+xJ7hXWWw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.32.1.tgz", + "integrity": "sha512-PKvszb+9o/vVdUzCCjL0sKHukEQV39tD3fepXxYrHE3sTKrRdCydI7uldRLbjLmDA3TFDmh418XH19NOsDRH8g==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.32.1.tgz", + "integrity": "sha512-9WHEMV6Y89eL606ReYowXuGF1Yb2vwfKWKdD1A5h+OYnPZSJvxbEjxTRKPgi7tkP2DSnW0YLab1ooy+i/FQp/Q==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.32.1.tgz", + "integrity": "sha512-tZWc9iEt5fGJ1CL2LRPw8OttkCBDs+D8D3oEM8mH8S1ICZCtFJhD7DZ3XMGM8kpqHvhGUTvNUYVDnmkj4BDXnw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.32.1.tgz", + "integrity": "sha512-FTYc2YoTWUsBz5GTTgGkRYYJ5NGJIi/rCY4oK/I8aKowx1ToXeoVVbIE4LGAjsauvlhjfl0MYacxClLld1VrOw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loongarch64-gnu": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.32.1.tgz", + "integrity": "sha512-F51qLdOtpS6P1zJVRzYM0v6MrBNypyPEN1GfMiz0gPu9jN8ScGaEFIZQwteSsGKg799oR5EaP7+B2jHgL+d+Kw==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.32.1.tgz", + "integrity": "sha512-wO0WkfSppfX4YFm5KhdCCpnpGbtgQNj/tgvYzrVYFKDpven8w2N6Gg5nB6w+wAMO3AIfSTWeTjfVe+uZ23zAlg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.32.1.tgz", + "integrity": "sha512-iWswS9cIXfJO1MFYtI/4jjlrGb/V58oMu4dYJIKnR5UIwbkzR0PJ09O0PDZT0oJ3LYWXBSWahNf/Mjo6i1E5/g==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.32.1.tgz", + "integrity": "sha512-RKt8NI9tebzmEthMnfVgG3i/XeECkMPS+ibVZjZ6mNekpbbUmkNWuIN2yHsb/mBPyZke4nlI4YqIdFPgKuoyQQ==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.32.1.tgz", + "integrity": "sha512-WQFLZ9c42ECqEjwg/GHHsouij3pzLXkFdz0UxHa/0OM12LzvX7DzedlY0SIEly2v18YZLRhCRoHZDxbBSWoGYg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.32.1.tgz", + "integrity": "sha512-BLoiyHDOWoS3uccNSADMza6V6vCNiphi94tQlVIL5de+r6r/CCQuNnerf+1g2mnk2b6edp5dk0nhdZ7aEjOBsA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.32.1.tgz", + "integrity": "sha512-w2l3UnlgYTNNU+Z6wOR8YdaioqfEnwPjIsJ66KxKAf0p+AuL2FHeTX6qvM+p/Ue3XPBVNyVSfCrfZiQh7vZHLQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.32.1.tgz", + "integrity": "sha512-Am9H+TGLomPGkBnaPWie4F3x+yQ2rr4Bk2jpwy+iV+Gel9jLAu/KqT8k3X4jxFPW6Zf8OMnehyutsd+eHoq1WQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.32.1.tgz", + "integrity": "sha512-ar80GhdZb4DgmW3myIS9nRFYcpJRSME8iqWgzH2i44u+IdrzmiXVxeFnExQ5v4JYUSpg94bWjevMG8JHf1Da5Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@types/estree": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", + "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/github-script": { + "name": "@actions/github-script", + "version": "7.0.1", + "resolved": "git+ssh://git@github.com/actions/github-script.git#c94e1c45ffd9134aae340a84a0287033d610a783", + "dev": true, + "license": "MIT", + "dependencies": { + "@actions/core": "^1.10.1", + "@actions/exec": "^1.1.1", + "@actions/github": "^6.0.0", + "@actions/glob": "^0.4.0", + "@actions/io": "^1.1.3", + "@octokit/core": "^5.0.1", + "@octokit/plugin-request-log": "^4.0.0", + "@octokit/plugin-retry": "^6.0.1", + "@types/node": "^20.9.0" + }, + "engines": { + "node": ">=20.0.0 <21.0.0" + } + }, + "node_modules/@types/node": { + "version": "20.17.16", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.16.tgz", + "integrity": "sha512-vOTpLduLkZXePLxHiHsBLp98mHGnl8RptV4YAO3HfKO5UHjDvySGbxKtpYfy8Sx5+WKcgc45qNreJJRVM3L6mw==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~6.19.2" + } + }, + "node_modules/@vitest/coverage-v8": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.0.4.tgz", + "integrity": "sha512-f0twgRCHgbs24Dp8cLWagzcObXMcuKtAwgxjJV/nnysPAJJk1JiKu/W0gIehZLmkljhJXU/E0/dmuQzsA/4jhA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@ampproject/remapping": "^2.3.0", + "@bcoe/v8-coverage": "^1.0.2", + "debug": "^4.4.0", + "istanbul-lib-coverage": "^3.2.2", + "istanbul-lib-report": "^3.0.1", + "istanbul-lib-source-maps": "^5.0.6", + "istanbul-reports": "^3.1.7", + "magic-string": "^0.30.17", + "magicast": "^0.3.5", + "std-env": "^3.8.0", + "test-exclude": "^7.0.1", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@vitest/browser": "3.0.4", + "vitest": "3.0.4" + }, + "peerDependenciesMeta": { + "@vitest/browser": { + "optional": true + } + } + }, + "node_modules/@vitest/expect": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.0.4.tgz", + "integrity": "sha512-Nm5kJmYw6P2BxhJPkO3eKKhGYKRsnqJqf+r0yOGRKpEP+bSCBDsjXgiu1/5QFrnPMEgzfC38ZEjvCFgaNBC0Eg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.0.4", + "@vitest/utils": "3.0.4", + "chai": "^5.1.2", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.0.4.tgz", + "integrity": "sha512-gEef35vKafJlfQbnyOXZ0Gcr9IBUsMTyTLXsEQwuyYAerpHqvXhzdBnDFuHLpFqth3F7b6BaFr4qV/Cs1ULx5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.0.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/pretty-format": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.0.4.tgz", + "integrity": "sha512-ts0fba+dEhK2aC9PFuZ9LTpULHpY/nd6jhAQ5IMU7Gaj7crPCTdCFfgvXxruRBLFS+MLraicCuFXxISEq8C93g==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.0.4.tgz", + "integrity": "sha512-dKHzTQ7n9sExAcWH/0sh1elVgwc7OJ2lMOBrAm73J7AH6Pf9T12Zh3lNE1TETZaqrWFXtLlx3NVrLRb5hCK+iw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "3.0.4", + "pathe": "^2.0.2" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.0.4.tgz", + "integrity": "sha512-+p5knMLwIk7lTQkM3NonZ9zBewzVp9EVkVpvNta0/PlFWpiqLaRcF4+33L1it3uRUCh0BGLOaXPPGEjNKfWb4w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.0.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.2" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.0.4.tgz", + "integrity": "sha512-sXIMF0oauYyUy2hN49VFTYodzEAu744MmGcPR3ZBsPM20G+1/cSW/n1U+3Yu/zHxX2bIDe1oJASOkml+osTU6Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyspy": "^3.0.2" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.0.4.tgz", + "integrity": "sha512-8BqC1ksYsHtbWH+DfpOAKrFw3jl3Uf9J7yeFh85Pz52IWuh1hBBtyfEbRNNZNjl8H8A5yMLH9/t+k7HIKzQcZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.0.4", + "loupe": "^3.1.2", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/ansi-regex": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", + "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/ansi-styles": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", + "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true, + "license": "MIT" + }, + "node_modules/before-after-hook": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.3.tgz", + "integrity": "sha512-NzUnlZexiaH/46WDhANlyR2bXRopNg4F/zuSA3OpZnllCUgRaOF2znDioDWrmbNVsuZk6l9pMquQB38cfBZwkQ==", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/bottleneck": { + "version": "2.19.5", + "resolved": "https://registry.npmjs.org/bottleneck/-/bottleneck-2.19.5.tgz", + "integrity": "sha512-VHiNCbI1lKdl44tGrhNfU3lup0Tj/ZBMJB5/2ZbNXRCPuRCO7ed2mgcK4r17y+KB2EfuYuRaVlwNbAeaWGSpbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/cac": { + "version": "6.7.14", + "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", + "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/chai": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.1.2.tgz", + "integrity": "sha512-aGtmf24DW6MLHHG5gCx4zaI3uBq3KRtxeVs0DjFH6Z0rDNbsvTxFASFvdj79pxjxZ8/5u3PIiN3IwEIQkiiuPw==", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/check-error": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.1.tgz", + "integrity": "sha512-OAlb+T7V4Op9OwdkjmguYRqncdlx5JiofwOAUkmTF+jNdHwzTaTs4sRAGpzLF3oOz5xAyDGrPgeIDFQmDOTiJw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 16" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true, + "license": "MIT" + }, + "node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/debug": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-eql": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/deprecation": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", + "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/eastasianwidth": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", + "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", + "dev": true, + "license": "MIT" + }, + "node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "dev": true, + "license": "MIT" + }, + "node_modules/es-module-lexer": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.6.0.tgz", + "integrity": "sha512-qqnD1yMU6tk/jnaMosogGySTZP8YtUgAffA9nMN+E/rjxcfRQ6IEk7IiozUjgxKoFHBGjTLnrHB/YC45r/59EQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/esbuild": { + "version": "0.24.2", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.24.2.tgz", + "integrity": "sha512-+9egpBW8I3CD5XPe0n6BfT5fxLzxrlDzqydF3aviG+9ni1lDC/OvMHcxqEFV0+LANZG5R1bFMWfUrjVsdwxJvA==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.24.2", + "@esbuild/android-arm": "0.24.2", + "@esbuild/android-arm64": "0.24.2", + "@esbuild/android-x64": "0.24.2", + "@esbuild/darwin-arm64": "0.24.2", + "@esbuild/darwin-x64": "0.24.2", + "@esbuild/freebsd-arm64": "0.24.2", + "@esbuild/freebsd-x64": "0.24.2", + "@esbuild/linux-arm": "0.24.2", + "@esbuild/linux-arm64": "0.24.2", + "@esbuild/linux-ia32": "0.24.2", + "@esbuild/linux-loong64": "0.24.2", + "@esbuild/linux-mips64el": "0.24.2", + "@esbuild/linux-ppc64": "0.24.2", + "@esbuild/linux-riscv64": "0.24.2", + "@esbuild/linux-s390x": "0.24.2", + "@esbuild/linux-x64": "0.24.2", + "@esbuild/netbsd-arm64": "0.24.2", + "@esbuild/netbsd-x64": "0.24.2", + "@esbuild/openbsd-arm64": "0.24.2", + "@esbuild/openbsd-x64": "0.24.2", + "@esbuild/sunos-x64": "0.24.2", + "@esbuild/win32-arm64": "0.24.2", + "@esbuild/win32-ia32": "0.24.2", + "@esbuild/win32-x64": "0.24.2" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/expect-type": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.1.0.tgz", + "integrity": "sha512-bFi65yM+xZgk+u/KRIpekdSYkTB5W1pEf0Lt8Q8Msh7b+eQ7LXVtIB1Bkm4fvclDEL1b2CZkMhv2mOeF8tMdkA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/foreground-child": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.0.tgz", + "integrity": "sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg==", + "dev": true, + "license": "ISC", + "dependencies": { + "cross-spawn": "^7.0.0", + "signal-exit": "^4.0.1" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/glob": { + "version": "10.4.5", + "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", + "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", + "dev": true, + "license": "ISC", + "dependencies": { + "foreground-child": "^3.1.0", + "jackspeak": "^3.1.2", + "minimatch": "^9.0.4", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^1.11.1" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/glob/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true, + "license": "ISC" + }, + "node_modules/istanbul-lib-coverage": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", + "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-report": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", + "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "istanbul-lib-coverage": "^3.0.0", + "make-dir": "^4.0.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-source-maps": { + "version": "5.0.6", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-5.0.6.tgz", + "integrity": "sha512-yg2d+Em4KizZC5niWhQaIomgf5WlL4vOOjZ5xGCmF8SnPE/mDWWXgvRExdcpCgh9lLRRa1/fSYp2ymmbJ1pI+A==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.23", + "debug": "^4.1.1", + "istanbul-lib-coverage": "^3.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-reports": { + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", + "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "html-escaper": "^2.0.0", + "istanbul-lib-report": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/jackspeak": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", + "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + }, + "optionalDependencies": { + "@pkgjs/parseargs": "^0.11.0" + } + }, + "node_modules/loupe": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.3.tgz", + "integrity": "sha512-kkIp7XSkP78ZxJEsSxW3712C6teJVoeHHwgo9zJ380de7IYyJ2ISlxojcH2pC5OFLewESmnRi/+XCDIEEVyoug==", + "dev": true, + "license": "MIT" + }, + "node_modules/lru-cache": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", + "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/magic-string": { + "version": "0.30.17", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.17.tgz", + "integrity": "sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0" + } + }, + "node_modules/magicast": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.3.5.tgz", + "integrity": "sha512-L0WhttDl+2BOsybvEOLK7fW3UA0OQ0IQ2d6Zl2x/a6vVRs3bAY0ECOSHHeL5jD+SbOpOCUEi0y1DgHEn9Qn1AQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.25.4", + "@babel/types": "^7.25.4", + "source-map-js": "^1.2.0" + } + }, + "node_modules/make-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", + "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "^7.5.3" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.8", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.8.tgz", + "integrity": "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/package-json-from-dist": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", + "dev": true, + "license": "BlueOak-1.0.0" + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-scurry": { + "version": "1.11.1", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", + "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "lru-cache": "^10.2.0", + "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + }, + "engines": { + "node": ">=16 || 14 >=14.18" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/pathe": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.2.tgz", + "integrity": "sha512-15Ztpk+nov8DR524R4BF7uEuzESgzUEAV4Ah7CUMNGXdE5ELuvxElxGXndBl32vMSsWa1jpNf22Z+Er3sKwq+w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathval": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.0.tgz", + "integrity": "sha512-vE7JKRyES09KiunauX7nd2Q9/L7lhok4smP9RZTDeD4MVs72Dp2qNFVz39Nz5a0FVEW0BJR6C0DYrq6unoziZA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/postcss": { + "version": "8.5.1", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.1.tgz", + "integrity": "sha512-6oz2beyjc5VMn/KV1pPw8fliQkhBXrVn1Z3TVyqZxU8kZpzEKhBdmCFqI6ZbmGtamQvQGuU1sgPTk8ZrXDD7jQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.8", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/prettier": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.4.2.tgz", + "integrity": "sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ==", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, + "node_modules/rollup": { + "version": "4.32.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.32.1.tgz", + "integrity": "sha512-z+aeEsOeEa3mEbS1Tjl6sAZ8NE3+AalQz1RJGj81M+fizusbdDMoEJwdJNHfaB40Scr4qNu+welOfes7maKonA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.6" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.32.1", + "@rollup/rollup-android-arm64": "4.32.1", + "@rollup/rollup-darwin-arm64": "4.32.1", + "@rollup/rollup-darwin-x64": "4.32.1", + "@rollup/rollup-freebsd-arm64": "4.32.1", + "@rollup/rollup-freebsd-x64": "4.32.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.32.1", + "@rollup/rollup-linux-arm-musleabihf": "4.32.1", + "@rollup/rollup-linux-arm64-gnu": "4.32.1", + "@rollup/rollup-linux-arm64-musl": "4.32.1", + "@rollup/rollup-linux-loongarch64-gnu": "4.32.1", + "@rollup/rollup-linux-powerpc64le-gnu": "4.32.1", + "@rollup/rollup-linux-riscv64-gnu": "4.32.1", + "@rollup/rollup-linux-s390x-gnu": "4.32.1", + "@rollup/rollup-linux-x64-gnu": "4.32.1", + "@rollup/rollup-linux-x64-musl": "4.32.1", + "@rollup/rollup-win32-arm64-msvc": "4.32.1", + "@rollup/rollup-win32-ia32-msvc": "4.32.1", + "@rollup/rollup-win32-x64-msvc": "4.32.1", + "fsevents": "~2.3.2" + } + }, + "node_modules/semver": { + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, + "node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "3.8.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.8.0.tgz", + "integrity": "sha512-Bc3YwwCB+OzldMxOXJIIvC6cPRWr/LxOp48CdQTOkPyk/t4JWWJbrilwBd7RJzKV8QW7tJkcgAmeuLLJugl5/w==", + "dev": true, + "license": "MIT" + }, + "node_modules/string-width": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", + "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "eastasianwidth": "^0.2.0", + "emoji-regex": "^9.2.2", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/string-width-cjs": { + "name": "string-width", + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width-cjs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true, + "license": "MIT" + }, + "node_modules/string-width-cjs/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/strip-ansi-cjs": { + "name": "strip-ansi", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/test-exclude": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.1.tgz", + "integrity": "sha512-pFYqmTw68LXVjeWJMST4+borgQP2AyMNbg1BpZh9LbyhUeNkeaPF9gzfPGUAnSMV3qPYdWUwDIjjCLiSDOl7vg==", + "dev": true, + "license": "ISC", + "dependencies": { + "@istanbuljs/schema": "^0.1.2", + "glob": "^10.4.1", + "minimatch": "^9.0.4" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/test-exclude/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/test-exclude/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinypool": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.0.2.tgz", + "integrity": "sha512-al6n+QEANGFOMf/dmUMsuS5/r9B06uwlyNjZZql/zv8J7ybHCgoihBNORZCY2mzUuAnomQa2JdhyHKzZxPCrFA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tinyspy": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-3.0.2.tgz", + "integrity": "sha512-n1cw8k1k0x4pgA2+9XrOkFydTerNcJ1zWCO5Nn9scWHTD+5tp8dghT2x1uduQePZTZgd3Tupf+x9BxJjeJi77Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tunnel": { + "version": "0.0.6", + "resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz", + "integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.6.11 <=0.7.0 || >=0.7.3" + } + }, + "node_modules/undici": { + "version": "5.28.5", + "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.5.tgz", + "integrity": "sha512-zICwjrDrcrUE0pyyJc1I2QzBkLM8FINsgOrt6WjA+BgajVq9Nxu2PbFFXUrAggLfDXlZGZBVZYw7WNV5KiBiBA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@fastify/busboy": "^2.0.0" + }, + "engines": { + "node": ">=14.0" + } + }, + "node_modules/undici-types": { + "version": "6.19.8", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", + "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "dev": true, + "license": "MIT" + }, + "node_modules/universal-user-agent": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-6.0.1.tgz", + "integrity": "sha512-yCzhz6FN2wU1NiiQRogkTQszlQSlpWaw8SvVegAc+bDxbzHgh1vX8uIe8OYyMH6DwH+sdTJsgMl36+mSMdRJIQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/vite": { + "version": "6.0.11", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.0.11.tgz", + "integrity": "sha512-4VL9mQPKoHy4+FE0NnRE/kbY51TOfaknxAjt3fJbGJxhIpBZiqVzlZDEesWWsuREXHwNdAoOFZ9MkPEVXczHwg==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.24.2", + "postcss": "^8.4.49", + "rollup": "^4.23.0" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", + "less": "*", + "lightningcss": "^1.21.0", + "sass": "*", + "sass-embedded": "*", + "stylus": "*", + "sugarss": "*", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-node": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.0.4.tgz", + "integrity": "sha512-7JZKEzcYV2Nx3u6rlvN8qdo3QV7Fxyt6hx+CCKz9fbWxdX5IvUOmTWEAxMrWxaiSf7CKGLJQ5rFu8prb/jBjOA==", + "dev": true, + "license": "MIT", + "dependencies": { + "cac": "^6.7.14", + "debug": "^4.4.0", + "es-module-lexer": "^1.6.0", + "pathe": "^2.0.2", + "vite": "^5.0.0 || ^6.0.0" + }, + "bin": { + "vite-node": "vite-node.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/vitest": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.0.4.tgz", + "integrity": "sha512-6XG8oTKy2gnJIFTHP6LD7ExFeNLxiTkK3CfMvT7IfR8IN+BYICCf0lXUQmX7i7JoxUP8QmeP4mTnWXgflu4yjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/expect": "3.0.4", + "@vitest/mocker": "3.0.4", + "@vitest/pretty-format": "^3.0.4", + "@vitest/runner": "3.0.4", + "@vitest/snapshot": "3.0.4", + "@vitest/spy": "3.0.4", + "@vitest/utils": "3.0.4", + "chai": "^5.1.2", + "debug": "^4.4.0", + "expect-type": "^1.1.0", + "magic-string": "^0.30.17", + "pathe": "^2.0.2", + "std-env": "^3.8.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinypool": "^1.0.2", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0", + "vite-node": "3.0.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.0.4", + "@vitest/ui": "3.0.4", + "happy-dom": "*", + "jsdom": "*" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@types/debug": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + } + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", + "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^6.1.0", + "string-width": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs": { + "name": "wrap-ansi", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true, + "license": "MIT" + }, + "node_modules/wrap-ansi-cjs/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/wrap-ansi-cjs/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true, + "license": "ISC" + } + } +} diff --git a/.github/package.json b/.github/package.json index febfead671ba..d3da6d46f5a0 100644 --- a/.github/package.json +++ b/.github/package.json @@ -6,7 +6,7 @@ "@octokit/webhooks-types": "^7.5.1", "@vitest/coverage-v8": "^3.0.2", "prettier": "^3.3.3", - "vitest": "^3.0.4" + "vitest": "^3.0.2" }, "scripts": { "test": "vitest", diff --git a/.github/workflows/github-test.yaml b/.github/workflows/github-test.yaml index bb4c7b68ceb5..1c67764b447e 100644 --- a/.github/workflows/github-test.yaml +++ b/.github/workflows/github-test.yaml @@ -32,7 +32,6 @@ jobs: with: # actions/github-script@v7 uses Node 20 node-version: 20.x - install-command: 'npm install' working-directory: ./.github - name: Run tests diff --git a/.gitignore b/.gitignore index 8df07769a444..2cd5372e6e34 100644 --- a/.gitignore +++ b/.gitignore @@ -135,6 +135,7 @@ eng/tools/**/dist # No package-lock.json files should be commited except the top-level. **/package-lock.json !/package-lock.json +!/.github/package-lock.json # No Armstrong outputs should be commited except the tf files. **/terraform/**/*.json From d67a8c90257522eff6013707bcceeaddacda8ba6 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 28 Jan 2025 22:37:08 -0800 Subject: [PATCH 61/74] [dependabot] Ignore `@types/github-script` (#32383) --- .github/dependabot.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 792406b01c75..302be61732c3 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -44,3 +44,5 @@ updates: - dependency-name: "@types/node" # Updated manually to align with repo microsoft/typespec - dependency-name: "prettier" + # Points to "github:actions/github-script" since package isn't published to npmjs + - dependency-name: "@types/github-script" From b0fc2a2389b4563d46b6a54b959b8e93d658d7de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= Date: Wed, 29 Jan 2025 10:16:39 +0000 Subject: [PATCH 62/74] [NetAppFiles] Release netapp microsoft.net app 2024 09 01 (#31607) * Copy files from stable/2024-07-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-09-01 Updated the API version from stable/2024-07-01 to stable/2024-09-01. * Added tag for 2024-09-01 in readme file * prettier * bump to 2024-09-01 coolaccess and transionscmk * enum name * arm-id --- .../examples/Accounts_ChangeKeyVault.json | 26 + .../examples/Accounts_CreateOrUpdate.json | 36 + .../examples/Accounts_CreateOrUpdateAD.json | 81 + .../2024-09-01/examples/Accounts_Delete.json | 16 + .../2024-09-01/examples/Accounts_Get.json | 36 + ...Accounts_GetChangeKeyVaultInformation.json | 15 + .../2024-09-01/examples/Accounts_List.json | 24 + .../examples/Accounts_RenewCredentials.json | 17 + .../Accounts_TransitionEncryptionKey.json | 20 + .../2024-09-01/examples/Accounts_Update.json | 46 + .../examples/BackupPolicies_Create.json | 51 + .../examples/BackupPolicies_Delete.json | 18 + .../examples/BackupPolicies_Get.json | 33 + .../examples/BackupPolicies_List.json | 29 + .../examples/BackupPolicies_Update.json | 70 + .../examples/BackupVaults_Create.json | 36 + .../examples/BackupVaults_Delete.json | 18 + .../2024-09-01/examples/BackupVaults_Get.json | 25 + .../examples/BackupVaults_List.json | 28 + .../examples/BackupVaults_Update.json | 48 + .../examples/BackupsUnderAccount_Migrate.json | 19 + .../BackupsUnderBackupVault_Create.json | 50 + .../BackupsUnderBackupVault_Delete.json | 19 + .../examples/BackupsUnderBackupVault_Get.json | 29 + .../BackupsUnderBackupVault_List.json | 32 + ...upsUnderBackupVault_SingleFileRestore.json | 24 + .../BackupsUnderBackupVault_Update.json | 49 + .../examples/BackupsUnderVolume_Migrate.json | 21 + .../examples/CheckFilePathAvailability.json | 18 + .../examples/CheckNameAvailability.json | 19 + .../examples/CheckQuotaAvailability.json | 19 + .../examples/GroupIdListForLDAPUser.json | 29 + .../examples/NetworkSiblingSet_Query.json | 42 + .../examples/NetworkSiblingSet_Update.json | 49 + .../2024-09-01/examples/OperationList.json | 1565 +++ .../examples/Pools_CreateOrUpdate.json | 51 + .../2024-09-01/examples/Pools_Delete.json | 17 + .../stable/2024-09-01/examples/Pools_Get.json | 28 + .../2024-09-01/examples/Pools_List.json | 31 + .../2024-09-01/examples/Pools_Update.json | 34 + .../2024-09-01/examples/QuotaLimits_Get.json | 21 + .../2024-09-01/examples/QuotaLimits_List.json | 87 + .../2024-09-01/examples/RegionInfo.json | 20 + .../2024-09-01/examples/RegionInfos_Get.json | 33 + .../2024-09-01/examples/RegionInfos_List.json | 37 + .../examples/SnapshotPolicies_Create.json | 104 + .../examples/SnapshotPolicies_Delete.json | 18 + .../examples/SnapshotPolicies_Get.json | 44 + .../examples/SnapshotPolicies_List.json | 47 + .../SnapshotPolicies_ListVolumes.json | 36 + .../examples/SnapshotPolicies_Update.json | 107 + .../2024-09-01/examples/Snapshots_Create.json | 31 + .../2024-09-01/examples/Snapshots_Delete.json | 20 + .../2024-09-01/examples/Snapshots_Get.json | 26 + .../2024-09-01/examples/Snapshots_List.json | 29 + .../examples/Snapshots_SingleFileRestore.json | 25 + .../2024-09-01/examples/Snapshots_Update.json | 32 + .../examples/Subvolumes_Create.json | 42 + .../examples/Subvolumes_Delete.json | 20 + .../2024-09-01/examples/Subvolumes_Get.json | 24 + .../2024-09-01/examples/Subvolumes_List.json | 28 + .../examples/Subvolumes_Metadata.json | 35 + .../examples/Subvolumes_Update.json | 34 + .../examples/VolumeGroups_Create_Oracle.json | 965 ++ .../examples/VolumeGroups_Create_SapHana.json | 406 + .../examples/VolumeGroups_Delete.json | 18 + .../examples/VolumeGroups_Get_Oracle.json | 510 + .../examples/VolumeGroups_Get_SapHana.json | 220 + .../examples/VolumeGroups_List_Oracle.json | 31 + .../examples/VolumeGroups_List_SapHana.json | 31 + .../examples/VolumeQuotaRules_Create.json | 52 + .../examples/VolumeQuotaRules_Delete.json | 20 + .../examples/VolumeQuotaRules_Get.json | 27 + .../examples/VolumeQuotaRules_List.json | 31 + .../examples/VolumeQuotaRules_Update.json | 37 + .../Volumes_AuthorizeExternalReplication.json | 23 + .../Volumes_AuthorizeReplication.json | 21 + .../examples/Volumes_BreakFileLocks.json | 22 + .../examples/Volumes_BreakReplication.json | 21 + .../examples/Volumes_CreateOrUpdate.json | 58 + .../2024-09-01/examples/Volumes_Delete.json | 18 + .../examples/Volumes_DeleteReplication.json | 22 + .../Volumes_FinalizeExternalReplication.json | 17 + .../examples/Volumes_FinalizeRelocation.json | 22 + .../2024-09-01/examples/Volumes_Get.json | 32 + .../examples/Volumes_LatestBackupStatus.json | 24 + .../examples/Volumes_LatestRestoreStatus.json | 22 + .../2024-09-01/examples/Volumes_List.json | 35 + .../examples/Volumes_ListReplications.json | 27 + .../examples/Volumes_PeerExternalCluster.json | 33 + .../Volumes_PerformReplicationTransfer.json | 21 + .../examples/Volumes_PoolChange.json | 21 + .../Volumes_PopulateAvailabilityZones.json | 37 + .../Volumes_ReInitializeReplication.json | 22 + .../Volumes_ReestablishReplication.json | 20 + .../2024-09-01/examples/Volumes_Relocate.json | 19 + .../examples/Volumes_ReplicationStatus.json | 25 + .../examples/Volumes_ResetCifsPassword.json | 21 + .../examples/Volumes_ResyncReplication.json | 22 + .../2024-09-01/examples/Volumes_Revert.json | 21 + .../examples/Volumes_RevertRelocation.json | 22 + .../2024-09-01/examples/Volumes_Update.json | 43 + .../stable/2024-09-01/netapp.json | 10080 ++++++++++++++++ .../netapp/resource-manager/readme.md | 11 +- 104 files changed, 16847 insertions(+), 1 deletion(-) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_ChangeKeyVault.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdateAD.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_GetChangeKeyVaultInformation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_RenewCredentials.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_TransitionEncryptionKey.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderAccount_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderVolume_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckFilePathAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckNameAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckQuotaAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/GroupIdListForLDAPUser.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Query.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/OperationList.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfo.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_ListVolumes.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Metadata.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakFileLocks.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_DeleteReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestBackupStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestRestoreStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ListReplications.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PeerExternalCluster.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PerformReplicationTransfer.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PoolChange.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PopulateAvailabilityZones.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReInitializeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReestablishReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Relocate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReplicationStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResetCifsPassword.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResyncReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Revert.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_RevertRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/netapp.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_ChangeKeyVault.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_ChangeKeyVault.json new file mode 100644 index 000000000000..16c5e76c57e9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_ChangeKeyVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": { + "keyVaultUri": "https://my-key-vault.managedhsm.azure.net", + "keyName": "rsakey", + "keyVaultResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "keyVaultPrivateEndpoints": [ + { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..8ebe935367c1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..8bb2cdf9e488 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": { + "activeDirectories": [ + { + "site": "SiteName", + "username": "ad_user_name", + "password": "ad_password", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..c51ada4c2ab0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..0ca8b2986025 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "site": "SiteName", + "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", + "username": "ad_user_name", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_GetChangeKeyVaultInformation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_GetChangeKeyVaultInformation.json new file mode 100644 index 000000000000..87b9f3e3de6a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_GetChangeKeyVaultInformation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_List.json new file mode 100644 index 000000000000..c9c62d542ac3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..7d3fddcfb625 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_TransitionEncryptionKey.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_TransitionEncryptionKey.json new file mode 100644 index 000000000000..e00687f7ee3d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_TransitionEncryptionKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..9e44ae95bb2b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..856d850f40a8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..d8b6014dbd7c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..1440692d3294 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..37a17386b568 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1", + "name": "account1/backupPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..da991a9d70cb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupPolicies_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..249836cb5dc3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..68e878c8b3d8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..1adb00a657de --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_List.json new file mode 100644 index 000000000000..b30cbc3ac175 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..92f267324d05 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupVaults_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..16e0fa70b58c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..0a7b66b75f5d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01", + "body": { + "properties": { + "label": "myLabel", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..be360743d24b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..ab077390bfb0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..f49f0e7d59fc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..870d690b8098 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_SingleFileRestore.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01", + "body": { + "fileList": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ], + "destinationVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..6694393a106c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderBackupVault_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..af46927d31e2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..669d3acea7b7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "name": "my-exact-filepth", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..67cf045f487c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "name": "accName", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..b27e6ac5fe42 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "name": "resource1", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..d121bc5d52b9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/GroupIdListForLDAPUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "username": "user1" + } + }, + "responses": { + "200": { + "body": { + "groupIdsForLdapUser": [ + "123", + "224" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..687e75a01664 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..f3fec03b2cf6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/OperationList.json new file mode 100644 index 000000000000..93a565e49a54 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetApp/register/action", + "display": { + "provider": "Microsoft.NetApp", + "resource": "Subscription", + "operation": "Subscription Registration Action", + "description": "Subscription Registration Action" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume resource", + "description": "Reads a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write volume resource", + "description": "Writes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete volume resource", + "description": "Deletes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/Revert/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert volume resource", + "description": "Revert volume to specific snapshot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BreakReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Break volume replication resource", + "description": "Break volume replication relations" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ListReplications/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReInitializeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Re-Initialize replication", + "description": "Attempts to re-initialize an uninitialized replication" + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AverageReadLatency", + "displayName": "Average read latency", + "displayDescription": "Average read latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageReadLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "AverageWriteLatency", + "displayName": "Average write latency", + "displayDescription": "Average write latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageWriteLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeLogicalSize", + "displayName": "Volume Consumed Size", + "displayDescription": "Logical size of the volume (used bytes)", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeSnapshotSize", + "displayName": "Volume snapshot size", + "displayDescription": "Size of all snapshots in volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadIops", + "displayName": "Read iops", + "displayDescription": "Read In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteIops", + "displayName": "Write iops", + "displayDescription": "Write In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeAllocatedSize", + "displayName": "Volume allocated size", + "displayDescription": "The provisioned size of a volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierSize", + "displayName": "Volume cool tier size", + "displayDescription": "Volume Footprint for Cool Tier", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataReadSize", + "displayName": "Volume cool tier data read size", + "displayDescription": "Data read in using GET per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataReadSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataWriteSize", + "displayName": "Volume cool tier data write size", + "displayDescription": "Data tiered out using PUT per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataWriteSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferDuration", + "displayName": "Volume replication last transfer duration", + "displayDescription": "The amount of time in seconds it took for the last transfer to complete.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferDuration", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferSize", + "displayName": "Volume replication last transfer size", + "displayDescription": "The total number of bytes transferred as part of the last transfer.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationHealthy", + "displayName": "Is volume replication status healthy", + "displayDescription": "Condition of the relationship, 1 or 0.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationHealthy", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLagTime", + "displayName": "Volume replication lag time", + "displayDescription": "The amount of time in seconds by which the data on the mirror lags behind the source.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLagTime", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationTotalTransferBytes", + "displayName": "Volume replication total transfer", + "displayDescription": "Cumulative bytes transferred for the relationship.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationTotalTransferBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipProgress", + "displayName": "Volume replication progress", + "displayDescription": "Total amount of data transferred for the current transfer operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipProgress", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipTransferring", + "displayName": "Is volume replication transferring", + "displayDescription": "Whether the status of the Volume Replication is 'transferring'.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipTransferring", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeLogicalBackupBytes", + "displayName": "Volume Backup Bytes", + "displayDescription": "Total bytes backed up for this Volume.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeLogicalBackupBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeProtected", + "displayName": "Is Volume Backup Enabled", + "displayDescription": "Is backup enabled for the volume? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeProtected", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeBackupActive", + "displayName": "Is Volume Backup suspended", + "displayDescription": "Is the backup policy suspended for the volume? 0 if yes, 1 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeBackupActive", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationTransferredBytes", + "displayName": "Volume Backup Last Transferred Bytes", + "displayDescription": "Total bytes transferred for last backup or restore operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationTransferredBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationComplete", + "displayName": "Is Volume Backup Operation Complete", + "displayDescription": "Did the last volume backup or restore operation complete successfully? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationComplete", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeConsumedSizePercentage", + "displayName": "Percentage Volume Consumed Size", + "displayDescription": "The percentage of the volume consumed including snapshots.", + "unit": "Percent", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeConsumedSizePercentage", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "OtherThroughput", + "displayName": "Other throughput", + "displayDescription": "Other throughput (that is not read or write) in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "OtherThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadThroughput", + "displayName": "Read throughput", + "displayDescription": "Read throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "TotalThroughput", + "displayName": "Total throughput", + "displayDescription": "Sum of all throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "TotalThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteThroughput", + "displayName": "Write throughput", + "displayDescription": "Write throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/AuthorizeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Authorize Replication", + "description": "Authorize the source volume replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ResyncReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Resync Replication", + "description": "Resync the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/DeleteReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete Replication", + "description": "Delete the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/MountTargets/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read mount target resource", + "description": "Reads a mount target resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BackupStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RestoreStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/PoolChange/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Change pool for volume", + "description": "Moves volume to another pool." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RelocateVolume/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Relocate volume to a new stamp.", + "description": "Relocate volume to a new stamp." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/FinalizeRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Finalize relocation of volume.", + "description": "Finalize relocation by cleaning up the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RevertRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert the relocation of volume.", + "description": "Revert the relocation and revert back to the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Read account resource", + "description": "Reads an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Write account resource", + "description": "Writes an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Delete account resource", + "description": "Deletes a account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/RenewCredentials/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Renew MSI credentials, if possible.", + "description": "Renews MSI credentials of account, if account has MSI credentials that are due for renewal." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read pool resource", + "description": "Reads a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write pool resource", + "description": "Writes a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Delete pool resource", + "description": "Deletes a pool resource." + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "VolumePoolAllocatedUsed", + "displayName": "Pool Allocated To Volume Size", + "displayDescription": "Allocated used size of the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedUsed", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalLogicalSize", + "displayName": "Pool Consumed Size", + "displayDescription": "Sum of the logical size of all the volumes belonging to the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedSize", + "displayName": "Pool Allocated Size", + "displayDescription": "Provisioned size of this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalSnapshotSize", + "displayName": "Total Snapshot size for the pool", + "displayDescription": "Sum of snapshot size of all volumes in this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolProvisionedThroughput", + "displayName": "Provisioned throughput for the pool", + "displayDescription": "Provisioned throughput of this pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolProvisionedThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedToVolumeThroughput", + "displayName": "Pool allocated throughput", + "displayDescription": "Sum of the throughput of all the volumes belonging to the pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedToVolumeThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Autoscale", + "displayName": "Capacity Pool Autoscaled" + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read log definitions.", + "description": "Gets the log definitions for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Read snapshot resource", + "description": "Reads a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Write snapshot resource", + "description": "Writes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Delete snapshot resource", + "description": "Deletes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/RestoreFiles/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Single File Snapshot Restore", + "description": "Restores files from a snapshot resource" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Write subvolume Resource", + "description": "Write a subvolume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/GetMetadata/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Subvolume Metadata resource.", + "description": "Read subvolume metadata resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Read snapshot policy resource", + "description": "Reads a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Write snapshot policy resource", + "description": "Writes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Delete snapshot policy resource", + "description": "Deletes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/Volumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/ListVolumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Read backup resource.", + "description": "Reads a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Write backup resource.", + "description": "Writes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Delete backup resource", + "description": "Deletes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Read backup policy resource.", + "description": "Reads a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Write backup policy resource.", + "description": "Writes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Delete backup policy resource", + "description": "Deletes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/vaults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Vault resource type", + "operation": "Read vault resource.", + "description": "Reads a vault resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Read an account backup resource.", + "description": "Reads an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Write an account backup resource.", + "description": "Writes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Delete an account backup resource.", + "description": "Deletes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Read volume group resource", + "description": "Reads a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Write volume group resource", + "description": "Writes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Delete volume group resource", + "description": "Deletes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/quotaLimits/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "QuotaLimit resource type", + "operation": "Read QuotaLimit resource type", + "description": "Reads a Quotalimit resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/Operations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operations resource type", + "operation": "Read operation resource", + "description": "Reads an operation resources." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/operationresults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operation results resource type", + "operation": "Read operation result resource", + "description": "Reads an operation result resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Location wide operation", + "operation": "Read location wide operation", + "description": "Reads a location wide operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checknameavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "NetApp resources", + "operation": "Check if resource name is available", + "description": "Check if resource name is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkfilepathavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Check if file path is available", + "description": "Check if file path is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/unregister/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subscription", + "operation": "Unregister Subscription for Azure NetApp Files", + "description": "Unregisters Subscription with Microsoft.NetApp resource provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkinventory/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "ReservedCapacity reservation resource.", + "operation": "Checks ReservedCapacity inventory.", + "description": "Checks ReservedCapacity inventory." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..97bb8af4f82e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Premium", + "qosType": "Auto" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..1fcc223f1c48 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Get.json new file mode 100644 index 000000000000..00f911b91336 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_List.json new file mode 100644 index 000000000000..e59ed2021fb5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.474 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Update.json new file mode 100644 index 000000000000..5d31e1c93eb1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..94864fc5d85a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..aea5e247b43c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/accountsPerSubscription", + "name": "eastus/accountsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/poolsPerAccount", + "name": "eastus/poolsPerAccount", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 25, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/volumesPerPool", + "name": "eastus/volumesPerPool", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/snapshotsPerVolume", + "name": "eastus/snapshotsPerVolume", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 255, + "default": 255 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalTiBsPerSubscription", + "name": "eastus/totalTiBsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 1000, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalDPVolumesPerSubscription", + "name": "eastus/totalDPVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalVolumesPerSubscription", + "name": "eastus/totalVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfo.json new file mode 100644 index 000000000000..3e62e44dce3e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..5defa865a4a1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_List.json new file mode 100644 index 000000000000..5a0761cd2031 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..be3c26de909b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..3af526468b39 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..32378d13a667 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..71284998d3c9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "location": "eastus", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..cde55f6f7079 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..4a19f43d5286 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..f254278adc44 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Create.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01", + "location": "eastus", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..e9dd844d017f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..62b90a439340 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..3e7d5e3cd837 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..c45ce8149dbe --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_SingleFileRestore.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01", + "body": { + "filePaths": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..487e6d9abd36 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Snapshots_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..1728290fd9ca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Succeeded", + "size": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..97211a08aebd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..5d09ff382609 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_List.json new file mode 100644 index 000000000000..e276c3e8becf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..af45aacc0549 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Metadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata", + "name": "account1/pool1/volume1/subvolume1/metadata", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata", + "properties": { + "path": "/pathToSubvol", + "size": 5, + "bytesUsed": 5, + "permissions": "777", + "creationTimeStamp": "2017-08-15T13:23:33Z", + "accessedTimeStamp": "2017-08-15T13:23:33Z", + "modifiedTimeStamp": "2017-08-15T13:23:33Z", + "changedTimeStamp": "2017-08-15T13:23:33Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..be1560b49604 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Subvolumes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1", + "properties": { + "path": "/subvolumePath", + "size": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..e75366376a85 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_Oracle.json @@ -0,0 +1,965 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data1", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data1", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data2", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data2", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data3", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data3", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data4", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data4", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data5", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data5", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data6", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data6", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data7", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data7", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data8", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data8", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log-mirror", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log-mirror", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-binary", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-binary", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..c1e1fee98dd3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Create_SapHana.json @@ -0,0 +1,406 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "name": "test-data-mnt00001", + "properties": { + "creationToken": "test-data-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-mnt00001", + "properties": { + "creationToken": "test-log-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-shared", + "properties": { + "creationToken": "test-shared", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "shared", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-data-backup", + "properties": { + "creationToken": "test-data-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-backup", + "properties": { + "creationToken": "test-log-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-shared", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..bcf825a2d974 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..43f35e10dab8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_Oracle.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2", + "volumesCount": 12 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..a371c92a7bcb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_Get_SapHana.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-shared", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..2a8df1e8b8d9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "DEV", + "volumesCount": 12 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..e09fc60f995b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..46f37884ae00 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01", + "body": { + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Creating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..079403294441 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..89308be9d2cf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..9b6a448e4d01 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..43fa7dc3430e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/VolumeQuotaRules_Update.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01", + "body": { + "properties": { + "quotaSizeInKiBs": 100009 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "provisioningState": "Patching", + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeExternalReplication.json new file mode 100644 index 000000000000..0cdcf6d37995 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeExternalReplication.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "svmPeeringCommand": "vserver peer accept -vserver OnPremSvm -peer-vserver AnfSvm" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..30721a1d77f3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..d3c8a43ef07f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakFileLocks.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "clientIp": "101.102.103.104", + "confirmRunningDisruptiveOperation": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..0ed6e45b3f4a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_BreakReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..e1e3cf283efe --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": { + "creationToken": "my-unique-file-path", + "serviceLevel": "Premium", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..800e724b67ae --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..114548b73e45 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_DeleteReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeExternalReplication.json new file mode 100644 index 000000000000..5156fa8eed4b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeExternalReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..114548b73e45 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_FinalizeRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..82919d09b0ab --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..ae414cb496ca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestBackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..2fa5321d6518 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_LatestRestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_List.json new file mode 100644 index 000000000000..613de87782d4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..d9142db109e0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ListReplications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "replicationSchedule": "daily", + "remoteVolumeResourceId": "/subscriptions/36e85c76-e720-473e-881f-e2fe72f462d0/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-5999/capacityPools/pool-0977/volumes/volume-4508", + "remoteVolumeRegion": "westus" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PeerExternalCluster.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PeerExternalCluster.json new file mode 100644 index 000000000000..88805bb74162 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PeerExternalCluster.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "peerIpAddresses": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ] + } + }, + "responses": { + "200": { + "body": { + "peerAcceptCommand": "cluster peer create -ipspace replication -encryption-protocol-proposed tls-psk -passphrase passphraseString -peer-addrs 1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4,1.1.1.5,1.1.1.6" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..04242fc36178 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PerformReplicationTransfer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..d6dd31f6ff96 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PoolChange.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..70160cd2880c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_PopulateAvailabilityZones.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..114548b73e45 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..043cf04b771f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReestablishReplication.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "sourceVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..2b5120d862c4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Relocate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..12c436660137 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ReplicationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "totalProgress": "1048576", + "errorMessage": "" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..04242fc36178 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..114548b73e45 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_ResyncReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Revert.json new file mode 100644 index 000000000000..801a9364a17e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Revert.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..114548b73e45 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_RevertRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..15199b817ba2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/examples/Volumes_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/netapp.json new file mode 100644 index 000000000000..0edfc3fa4628 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-09-01/netapp.json @@ -0,0 +1,10080 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-09-01", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/transitiontocmk": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_TransitionToCmk", + "summary": "Transition volumes encryption from PMK to CMK.", + "description": "Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption transition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/encryptionTransitionRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_MigrateEncryptionKey": { + "$ref": "examples/Accounts_TransitionEncryptionKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_GetChangeKeyVaultInformation", + "summary": "Get information about how volumes under NetApp account are encrypted.", + "description": "Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_GetChangeKeyVaultInformation": { + "$ref": "examples/Accounts_GetChangeKeyVaultInformation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ChangeKeyVault", + "summary": "Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account.", + "description": "Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption migration.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/changeKeyVault" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_ChangeKeyVault": { + "$ref": "examples/Accounts_ChangeKeyVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster": { + "post": { + "summary": "Start Cluster peering", + "description": "Starts peering the external cluster for this migration volume", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_PeerExternalCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Cluster peer request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/peerClusterForVolumeMigrationRequest" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/clusterPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_PeerExternalCluster": { + "$ref": "examples/Volumes_PeerExternalCluster.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/clusterPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeExternalReplication": { + "post": { + "summary": "Start migration process", + "description": "Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_AuthorizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/svmPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_AuthorizeExternalReplication": { + "$ref": "examples/Volumes_AuthorizeExternalReplication.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/svmPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication": { + "post": { + "summary": "Finalize migration process", + "description": "Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.", + "tags": [ + "Volumes OnPrem Migration Finalize" + ], + "operationId": "Volumes_FinalizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_FinalizeExternalReplication": { + "$ref": "examples/Volumes_FinalizeExternalReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer": { + "post": { + "tags": [ + "Volumes OnPrem Migration" + ], + "summary": "Perform a replication transfer", + "description": "Performs an adhoc replication transfer on a volume with volumeType Migration", + "operationId": "Volumes_PerformReplicationTransfer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PerformReplicationTransfer": { + "$ref": "examples/Volumes_PerformReplicationTransfer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "availabilityZone": { + "title": "Logical availability zone", + "type": "string", + "example": "1", + "x-nullable": true, + "description": "The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed." + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + } + ] + }, + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups" + } + ] + }, + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "The original value of the network features type available to the volume at the time it was created.", + "example": "Basic" + }, + "effectiveNetworkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "The effective value of the network features type available to the volume, or current effective state of update.", + "readOnly": true, + "example": "Standard" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "coolAccessTieringPolicy": { + "$ref": "#/definitions/coolAccessTieringPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume. Required for cross region and cross zone replication" + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a ONTAP Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the ONTAP Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the replication.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8" + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "coolAccessTieringPolicy": { + "$ref": "#/definitions/coolAccessTieringPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + } + ] + } + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy GUID ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "DefaultUserQuota" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "encryptionTransitionRequest": { + "description": "Encryption transition request", + "type": "object", + "required": [ + "virtualNetworkId", + "privateEndpointId" + ], + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + }, + "description": "Identifier for the virtual network", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateEndpoints" + } + ] + }, + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "coolAccessTieringPolicy": { + "type": "string", + "description": "coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.", + "enum": [ + "Auto", + "SnapshotOnly" + ], + "x-ms-enum": { + "name": "coolAccessTieringPolicy", + "modelAsString": true + } + }, + "clusterPeerCommandResponse": { + "description": "Information about cluster peering process", + "type": "object", + "properties": { + "peerAcceptCommand": { + "description": "A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if clusterPeeringStatus is pending", + "type": "string" + } + } + }, + "svmPeerCommandResponse": { + "description": "Information about svm peering process", + "type": "object", + "properties": { + "svmPeeringCommand": { + "description": "A command that needs to be run on the external ONTAP to accept svm peering. Will only be present if svmPeeringStatus is pending", + "type": "string" + } + } + }, + "peerClusterForVolumeMigrationRequest": { + "description": "Source Cluster properties for a cluster peer request", + "type": "object", + "required": [ + "peerIpAddresses" + ], + "properties": { + "peerIpAddresses": { + "type": "array", + "minItems": 1, + "description": "A list of IC-LIF IPs that can be used to connect to the On-prem cluster", + "example": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ], + "items": { + "type": "string" + } + } + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + }, + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults" + } + ] + }, + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults" + } + ] + }, + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + }, + "changeKeyVault": { + "description": "Change key vault request", + "type": "object", + "required": [ + "keyVaultUri", + "keyName", + "keyVaultPrivateEndpoints" + ], + "properties": { + "keyVaultUri": { + "title": "keyVaultUri", + "description": "The URI of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "https://my-key-vault.managedhsm.azure.net" + }, + "keyName": { + "title": "keyName", + "description": "The name of the key that should be used for encryption.", + "type": "string", + "example": "rsaKeyName" + }, + "keyVaultResourceId": { + "title": "keyVaultResourceId", + "description": "Azure resource ID of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "keyVaultPrivateEndpoints": { + "title": "keyVaultPrivateEndpoints", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/keyVaultPrivateEndpoint" + }, + "x-ms-identifiers": [ + "virtualNetworkId" + ] + } + } + }, + "keyVaultPrivateEndpoint": { + "title": "keyVaultPrivateEndpoint", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "object", + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "description": "Identifier for the virtual network id", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + }, + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateEndpoints" + } + ] + }, + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index 49a5b9979b25..a4c7d252321e 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Azure NetApp Files API. title: NetAppManagementClient description: Microsoft NetApp Files Azure Resource Provider specification openapi-type: arm -tag: package-2024-07 +tag: package-2024-09-01 +``` + +### Tag: package-2024-09-01 + +These settings apply only when `--tag=package-2024-09-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-01' +input-file: + - Microsoft.NetApp/stable/2024-09-01/netapp.json ``` ### Tag: package-preview-2024-07-01-preview From e35e60938d5974926251ccf8f4bec18be4ba6358 Mon Sep 17 00:00:00 2001 From: YunsongB <39966392+YunsongB@users.noreply.github.com> Date: Wed, 29 Jan 2025 11:19:21 -0700 Subject: [PATCH 63/74] Add AOAI 2025-01-01-preview API version; (#32374) Co-authored-by: Yunsong Bai --- .../2025-01-01-preview/azureopenai.json | 4156 +++++ .../2025-01-01-preview/azureopenai.yaml | 2797 ++++ .../examples/cancel_batch.json | 41 + .../examples/cancel_batch.yaml | 33 + .../examples/cancel_finetuning_job.json | 40 + .../examples/cancel_finetuning_job.yaml | 36 + .../examples/delete_file.json | 18 + .../examples/delete_file.yaml | 12 + .../examples/delete_finetuning_job.json | 13 + .../examples/delete_finetuning_job.yaml | 9 + .../examples/get_batch.json | 41 + .../examples/get_batch.yaml | 33 + .../examples/get_batches.json | 50 + .../examples/get_batches.yaml | 39 + .../2025-01-01-preview/examples/get_file.json | 21 + .../2025-01-01-preview/examples/get_file.yaml | 16 + .../examples/get_file_content.json | 14 + .../examples/get_file_content.yaml | 9 + .../examples/get_files.json | 33 + .../examples/get_files.yaml | 24 + .../examples/get_finetuning_job.json | 45 + .../examples/get_finetuning_job.yaml | 38 + .../get_finetuning_job_checkpoints.json | 70 + .../get_finetuning_job_checkpoints.yaml | 54 + .../examples/get_finetuning_job_events.json | 43 + .../examples/get_finetuning_job_events.yaml | 33 + .../examples/get_finetuning_jobs.json | 50 + .../examples/get_finetuning_jobs.yaml | 40 + .../examples/get_ingestion_job.json | 27 + .../examples/get_ingestion_job.yaml | 21 + .../examples/get_ingestion_job_run.json | 30 + .../examples/get_ingestion_job_run.yaml | 18 + .../examples/get_model_base.json | 31 + .../examples/get_model_base.yaml | 25 + .../examples/get_model_finetune.json | 32 + .../examples/get_model_finetune.yaml | 24 + .../examples/get_models.json | 54 + .../examples/get_models.yaml | 41 + .../examples/import_file.json | 27 + .../examples/import_file.yaml | 47 + .../examples/list_ingestion_job_runs.json | 29 + .../examples/list_ingestion_job_runs.yaml | 16 + .../examples/list_ingestion_jobs.json | 22 + .../examples/list_ingestion_jobs.yaml | 12 + .../examples/post_batch.json | 52 + .../examples/post_batch.yaml | 41 + .../examples/post_finetuning_job.json | 57 + .../examples/post_finetuning_job.yaml | 53 + .../examples/put_ingestion_job_sc.json | 72 + .../examples/put_ingestion_job_sc.yaml | 51 + .../examples/put_ingestion_job_uc.json | 46 + .../examples/put_ingestion_job_uc.yaml | 39 + .../examples/upload_file.json | 24 + .../examples/upload_file.yaml | 19 + .../examples/upload_file_cancel.json | 31 + .../examples/upload_file_cancel.yaml | 25 + .../examples/upload_file_complete.json | 37 + .../examples/upload_file_complete.yaml | 30 + .../examples/upload_file_part.json | 22 + .../examples/upload_file_part.yaml | 16 + .../examples/upload_file_start.json | 38 + .../examples/upload_file_start.yaml | 30 + .../AzureOpenAI/authoring/readme.md | 20 + .../examples/audio_speech.json | 18 + .../examples/audio_speech.yaml | 12 + .../examples/audio_transcription_object.json | 15 + .../examples/audio_transcription_object.yaml | 9 + .../examples/audio_transcription_text.json | 15 + .../examples/audio_transcription_text.yaml | 19 + .../examples/audio_translation_object.json | 16 + .../examples/audio_translation_object.yaml | 21 + .../examples/audio_translation_text.json | 15 + .../examples/audio_translation_text.yaml | 21 + .../examples/cancel_run.json | 46 + .../examples/cancel_run.yaml | 35 + .../cancel_vector_store_file_batch.json | 27 + .../cancel_vector_store_file_batch.yaml | 20 + .../examples/chat_completions.json | 43 + .../examples/chat_completions.yaml | 45 + ...hat_completions_azure_search_advanced.json | 96 + ...hat_completions_azure_search_advanced.yaml | 63 + ...completions_azure_search_image_vector.json | 58 + ...completions_azure_search_image_vector.yaml | 36 + ...chat_completions_azure_search_minimum.json | 63 + ...chat_completions_azure_search_minimum.yaml | 39 + .../examples/chat_completions_cosmos_db.json | 77 + .../examples/chat_completions_cosmos_db.yaml | 49 + .../chat_completions_elasticsearch.json | 65 + .../chat_completions_elasticsearch.yaml | 41 + .../examples/chat_completions_mongo_db.json | 80 + .../examples/chat_completions_mongo_db.yaml | 52 + .../examples/chat_completions_pinecone.json | 77 + .../examples/chat_completions_pinecone.yaml | 51 + .../examples/completions.json | 38 + .../examples/create_assistant.json | 39 + .../examples/create_assistant.yaml | 26 + .../examples/create_message.json | 36 + .../examples/create_message.yaml | 25 + .../examples/create_run.json | 49 + .../examples/create_run.yaml | 38 + .../examples/create_thread.json | 17 + .../examples/create_thread.yaml | 11 + .../examples/create_thread_and_run.json | 54 + .../examples/create_thread_and_run.yaml | 42 + .../examples/create_vector_store.json | 28 + .../examples/create_vector_store.yaml | 20 + .../examples/create_vector_store_file.json | 24 + .../examples/create_vector_store_file.yaml | 17 + .../create_vector_store_file_batch.json | 30 + .../create_vector_store_file_batch.yaml | 22 + .../examples/delete_assistant.json | 17 + .../examples/delete_assistant.yaml | 11 + .../examples/delete_assistant_file.json | 18 + .../examples/delete_assistant_file.yaml | 12 + .../examples/delete_message.json | 18 + .../examples/delete_message.yaml | 12 + .../examples/delete_thread.json | 17 + .../examples/delete_thread.yaml | 11 + .../examples/delete_vector_store.json | 17 + .../examples/delete_vector_store.yaml | 11 + .../examples/delete_vector_store_file.json | 18 + .../examples/delete_vector_store_file.yaml | 12 + .../examples/embeddings.json | 1566 ++ .../examples/embeddings.yaml | 1553 ++ .../examples/generated_audio_speech.json | 19 + .../generated_audio_transcription_object.json | 17 + .../generated_audio_transcription_text.json | 16 + .../generated_audio_translation_object.json | 17 + .../generated_audio_translation_text.json | 16 + .../examples/generated_chat_completions.json | 45 + .../examples/generated_completions.json | 38 + .../examples/generated_embeddings.json | 1567 ++ ...extensions_chat_completions_aml_index.json | 62 + ...hat_completions_azure_search_advanced.json | 86 + ...completions_azure_search_image_vector.json | 67 + ...chat_completions_azure_search_minimum.json | 61 + ...extensions_chat_completions_cosmos_db.json | 78 + ...nsions_chat_completions_elasticsearch.json | 66 + ..._extensions_chat_completions_pinecone.json | 78 + .../examples/generated_image_generation.json | 31 + .../examples/get_assistant_file.json | 19 + .../examples/get_assistant_file.yaml | 13 + .../examples/get_message.json | 33 + .../examples/get_message.yaml | 23 + .../examples/get_message_file.json | 20 + .../examples/get_message_file.yaml | 14 + .../2025-01-01-preview/examples/get_run.json | 32 + .../2025-01-01-preview/examples/get_run.yaml | 26 + .../examples/get_run_step.json | 40 + .../examples/get_run_step.yaml | 31 + .../examples/image_generation.json | 71 + .../examples/image_generation.yaml | 49 + .../examples/list_assistant_files.json | 26 + .../examples/list_assistant_files.yaml | 17 + .../examples/list_assistants.json | 70 + .../examples/list_assistants.yaml | 54 + .../examples/list_message_files.json | 33 + .../examples/list_message_files.yaml | 22 + .../examples/list_messages.json | 60 + .../examples/list_messages.yaml | 41 + .../examples/list_run_steps.json | 47 + .../examples/list_run_steps.yaml | 35 + .../examples/list_runs.json | 112 + .../examples/list_runs.yaml | 85 + .../list_vector_store_file_batch.json | 33 + .../list_vector_store_file_batch.yaml | 22 + .../examples/list_vector_store_files.json | 32 + .../examples/list_vector_store_files.yaml | 21 + .../examples/list_vector_stores.json | 47 + .../examples/list_vector_stores.yaml | 51 + .../examples/modify_assistant.json | 44 + .../examples/modify_assistant.yaml | 29 + .../examples/modify_message.json | 42 + .../examples/modify_message.yaml | 29 + .../examples/modify_run.json | 66 + .../examples/modify_run.yaml | 55 + .../examples/modify_thread.json | 28 + .../examples/modify_thread.yaml | 19 + .../examples/modify_vector_store.json | 29 + .../examples/modify_vector_store.yaml | 21 + .../examples/retrieve_assistant.json | 30 + .../examples/retrieve_assistant.yaml | 21 + .../examples/retrieve_message.json | 33 + .../examples/retrieve_message.yaml | 23 + .../examples/retrieve_run.json | 51 + .../examples/retrieve_run.yaml | 40 + .../examples/retrieve_run_step.json | 40 + .../examples/retrieve_run_step.yaml | 31 + .../examples/retrieve_thread.json | 23 + .../examples/retrieve_thread.yaml | 15 + .../examples/retrieve_vector_store.json | 17 + .../examples/retrieve_vector_store.yaml | 11 + .../examples/retrieve_vector_store_file.json | 21 + .../examples/retrieve_vector_store_file.yaml | 15 + .../retrieve_vector_store_file_batch.json | 27 + .../retrieve_vector_store_file_batch.yaml | 20 + .../examples/submit_tool_outputs_to_run.json | 77 + .../examples/submit_tool_outputs_to_run.yaml | 57 + .../preview/2025-01-01-preview/inference.json | 12518 ++++++++++++++++ .../preview/2025-01-01-preview/inference.yaml | 8782 +++++++++++ .../AzureOpenAI/inference/readme.md | 7 + 201 files changed, 39664 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_aml_index.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.yaml diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.json new file mode 100644 index 000000000000..8c61826eb393 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.json @@ -0,0 +1,4156 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2025-01-01-preview", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2025-01-01-preview" + }, + "paths": { + "/batches": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets a list of all batches owned by the Azure OpenAI resource.", + "operationId": "Batch_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of batches to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "in": "query", + "name": "$filter", + "description": "The OData expression to describe the filtering conditions.", + "type": "string" + }, + { + "in": "query", + "name": "$orderby", + "description": "The OData expression to describe the sorting order.", + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchesList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all batches owned by this account.": { + "$ref": "./examples/get_batches.json" + } + } + }, + "post": { + "tags": [ + "Batch:" + ], + "summary": "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete.", + "operationId": "Batch_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "createBatchRequest", + "description": "The specification of the batch to create and execute.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCreateRequest" + } + } + ], + "responses": { + "201": { + "description": "The batch has been successfully created.", + "schema": { + "$ref": "#/definitions/Batch" + }, + "headers": { + "deployment-enqueued-tokens": { + "description": "Sum of enqueued tokens of all jobs that target to the deployment.", + "type": "integer", + "format": "int64" + }, + "deployment-maximum-enqueued-tokens": { + "description": "Maximum enqueued tokens of the deployment.", + "type": "integer", + "format": "int64" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a batch.": { + "$ref": "./examples/post_batch.json" + } + } + } + }, + "/batches/{batch-id}": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets details for a single batch specified by the given batch-id.", + "operationId": "Batch_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a batch.": { + "$ref": "./examples/get_batch.json" + } + } + } + }, + "/batches/{batch-id}/cancel": { + "post": { + "tags": [ + "Batch:" + ], + "summary": "Cancels the processing of the batch specified by the given batch-id.", + "operationId": "Batch_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The batch has been successfully canceled.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a batch.": { + "$ref": "./examples/cancel_batch.json" + } + } + } + }, + "/files": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job.", + "operationId": "Files_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "purpose", + "description": "Only return files with the given purpose.", + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FileList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all files owned by this account.": { + "$ref": "./examples/get_files.json" + } + } + }, + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + } + ] + } + }, + { + "in": "formData", + "name": "file", + "description": "Gets or sets the file to upload into Azure OpenAI.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a file.": { + "$ref": "./examples/upload_file.json" + } + } + } + }, + "/files/import": { + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fileImport", + "description": "The definition of the file to create including its purpose, the file name and the url of the file location.", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + } + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Importing a file with a blob url as source.": { + "$ref": "./examples/import_file.json" + } + } + } + }, + "/files/{file-id}": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets details for a single file specified by the given file-id including status, size, purpose, etc.", + "operationId": "Files_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a file.": { + "$ref": "./examples/get_file.json" + } + } + }, + "delete": { + "tags": [ + "Files:" + ], + "summary": "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job.", + "operationId": "Files_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The file was successfully deleted.", + "schema": { + "$ref": "#/definitions/FileDelete" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a file.": { + "$ref": "./examples/delete_file.json" + } + } + } + }, + "/files/{file-id}/content": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job.", + "operationId": "Files_GetContent", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting the file content.": { + "$ref": "./examples/get_file_content.json" + } + } + } + }, + "/fine_tuning/jobs": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tuning jobs owned by this account.": { + "$ref": "./examples/get_finetuning_jobs.json" + } + } + }, + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete.", + "operationId": "FineTuning_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTuningJob", + "description": "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others.", + "required": true, + "schema": { + "$ref": "#/definitions/FineTuningJobCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTuningJob" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a fine tuning job.": { + "$ref": "./examples/post_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tuning job.": { + "$ref": "./examples/get_finetuning_job.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The fine tune was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a fine tuning job.": { + "$ref": "./examples/delete_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/cancel": { + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The fine tune has been successfully canceled", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tuning job.": { + "$ref": "./examples/cancel_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training.", + "operationId": "FineTuning_GetCheckpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last checkpoint ID from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of checkpoints to retrieve. Defaults to 10.", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobCheckpointList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting checkpoints of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_checkpoints.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/events": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_GetEvents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobEventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_events.json" + } + } + } + }, + "/ingestion/jobs": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Lists the ingestion jobs.", + "operationId": "IngestionJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all ingestion jobs": { + "$ref": "./examples/list_ingestion_jobs.json" + } + } + } + }, + "/ingestion/jobs/{job-id}": { + "put": { + "tags": [ + "Ingestion:" + ], + "summary": "Creates an ingestion job with the specified job id.", + "operationId": "IngestionJobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "type": "string", + "description": "The id of the job that will be created." + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + }, + { + "in": "header", + "name": "aml-user-token", + "type": "string", + "description": "The token used to access the resources within the job in the workspace (needed only for user compute jobs)." + }, + { + "in": "body", + "name": "ingestionJob", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a system-compute ingestion job": { + "$ref": "./examples/put_ingestion_job_sc.json" + }, + "Create a user-compute ingestion job": { + "$ref": "./examples/put_ingestion_job_uc.json" + } + } + }, + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Gets the details of the specified job id.", + "operationId": "IngestionJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ingestion job": { + "$ref": "./examples/get_ingestion_job.json" + } + } + } + }, + "/ingestion/jobs/{job-id}/runs": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Lists the runs of the specified job id.", + "operationId": "IngestionJobRuns_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobRunList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ingestion job runs": { + "$ref": "./examples/list_ingestion_job_runs.json" + } + } + } + }, + "/ingestion/jobs/{job-id}/runs/{run-id}": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Gets the details of the specified run id as part of the specified job id.", + "operationId": "IngestionJobRuns_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + }, + { + "in": "path", + "name": "run-id", + "required": true, + "description": "The id of the run.", + "type": "string" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobRun" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ingestion job runs": { + "$ref": "./examples/get_ingestion_job_run.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.", + "operationId": "Models_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all models owned by account.": { + "$ref": "./examples/get_models.json" + } + } + } + }, + "/models/{model-id}": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets details for the model specified by the given modelId.", + "operationId": "Models_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "model-id", + "description": "The identifier of the model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a base model.": { + "$ref": "./examples/get_model_base.json" + }, + "Getting a fine-tuned model.": { + "$ref": "./examples/get_model_finetune.json" + } + } + } + }, + "/uploads": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file.", + "operationId": "UploadFile_Start", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileStartBody" + } + } + ], + "responses": { + "200": { + "description": "The upload has been successfully created.", + "schema": { + "$ref": "#/definitions/UploadResource" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a large file upload operation.": { + "$ref": "./examples/upload_file_start.json" + } + } + } + }, + "/uploads/{upload-id}/cancel": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled.", + "operationId": "UploadFile_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a large file upload operation.": { + "$ref": "./examples/upload_file_cancel.json" + } + } + } + }, + "/uploads/{upload-id}/complete": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed.", + "operationId": "UploadFile_Complete", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileCompleteBody" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Complete and validate a large file upload operation.": { + "$ref": "./examples/upload_file_complete.json" + } + } + } + }, + "/uploads/{upload-id}/parts": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB.", + "operationId": "UploadFile_Part", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "data", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadPartResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a part of large file upload operation.": { + "$ref": "./examples/upload_file_part.json" + } + } + } + } + }, + "definitions": { + "AzureAISearchIndex": { + "description": "Azure AI Search Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the Azure AI Search Index." + } + } + } + ], + "x-ms-discriminator-value": "AzureAISearch" + }, + "BaseConnection": { + "title": "BaseConnection", + "description": "A connection to a resource.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ConnectionType" + } + }, + "discriminator": "kind" + }, + "Batch": { + "title": "Batch", + "description": "Defines the values of a batch.", + "required": [ + "id", + "input_file_id" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string" + }, + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/BatchErrors" + }, + "input_file_id": { + "description": "The ID of the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/BatchStatus" + }, + "output_file_id": { + "description": "The ID of the file containing outputs of successfully executed requests.", + "type": "string" + }, + "error_file_id": { + "description": "The ID of the file containing outputs of requests with errors.", + "type": "string" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this batch was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "in_progress_at": { + "format": "unixtime", + "description": "A timestamp when this batch started progressing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expires_at": { + "format": "unixtime", + "description": "A timestamp when this batch will expire (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "finalizing_at": { + "format": "unixtime", + "description": "A timestamp when this batch started finalizing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "completed_at": { + "format": "unixtime", + "description": "A timestamp when this batch was completed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "failed_at": { + "format": "unixtime", + "description": "A timestamp when this batch failed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expired_at": { + "format": "unixtime", + "description": "A timestamp when this batch expired (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelling_at": { + "format": "unixtime", + "description": "A timestamp when this batch started cancelling (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelled_at": { + "format": "unixtime", + "description": "A timestamp when this batch was cancelled (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "request_counts": { + "$ref": "#/definitions/BatchRequestCounts" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchCreateRequest": { + "title": "BatchCreateRequest", + "description": "Defines the request to create a batch.", + "required": [ + "input_file_id", + "endpoint", + "completion_window" + ], + "type": "object", + "properties": { + "input_file_id": { + "description": "The ID if the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchErrorData": { + "title": "BatchErrorData", + "description": "Error information for a failure in batch.", + "type": "object", + "properties": { + "code": { + "description": "An error code identifying the error type.", + "type": "string" + }, + "message": { + "description": "A human-readable message providing more details about the error.", + "type": "string" + }, + "param": { + "description": "The name of the parameter that caused the error, if applicable (can be null).", + "type": "string" + }, + "line": { + "description": "The line number of the input file where the error occurred, if applicable (can be null).", + "type": "string" + } + } + }, + "BatchErrors": { + "title": "BatchErrors", + "description": "For batches that have failed, this will contain more information on the cause of the failures.", + "type": "object", + "properties": { + "object": { + "description": "The type of the errors object. This is always 'list'.", + "type": "string" + }, + "data": { + "$ref": "#/definitions/BatchErrorData" + } + } + }, + "BatchRequestCounts": { + "title": "BatchRequestCounts", + "description": "The request counts for different statuses within the batch.", + "type": "object", + "properties": { + "total": { + "description": "The total number of requests in the batch.", + "type": "integer" + }, + "completed": { + "description": "The number of requests in the batch that have been completed successfully.", + "type": "integer" + }, + "failed": { + "description": "The number of requests in the batch that have failed.", + "type": "integer" + } + } + }, + "BatchStatus": { + "title": "BatchStatus", + "description": "The status of a batch.", + "enum": [ + "validating", + "failed", + "in_progress", + "finalizing", + "completed", + "expired", + "cancelling", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BatchStatus", + "modelAsString": true, + "values": [ + { + "value": "validating", + "description": "The input file is being validated before the batch can begin." + }, + { + "value": "failed", + "description": "The input file has failed the validation process." + }, + { + "value": "in_progress", + "description": "The input file was successfully validated and the batch is currently being executed." + }, + { + "value": "finalizing", + "description": "The batch has completed and the results are being prepared." + }, + { + "value": "completed", + "description": "The batch has been completed and the results are ready." + }, + { + "value": "expired", + "description": "The batch was not able to complete within the 24-hour time window." + }, + { + "value": "cancelling", + "description": "Cancellation of the batch has been initiated." + }, + { + "value": "cancelled", + "description": "The batch was cancelled." + } + ] + } + }, + "BatchesList": { + "title": "BatchList", + "description": "Represents a list of batches.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Batch" + } + }, + "first_id": { + "description": "The id of the first batch in the list of batches returned.", + "type": "string" + }, + "last_id": { + "description": "The id of the last batch in the list of batches returned.", + "type": "string" + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "Capabilities": { + "title": "Capabilities", + "description": "The capabilities of a base or fine tune model.", + "required": [ + "chat_completion", + "completion", + "embeddings", + "fine_tune", + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "description": "A value indicating whether a model can be used for fine tuning.", + "type": "boolean" + }, + "inference": { + "description": "A value indicating whether a model can be deployed.", + "type": "boolean" + }, + "completion": { + "description": "A value indicating whether a model supports completion.", + "type": "boolean" + }, + "chat_completion": { + "description": "A value indicating whether a model supports chat completion.", + "type": "boolean" + }, + "embeddings": { + "description": "A value indicating whether a model supports embeddings.", + "type": "boolean" + } + } + }, + "ChunkingSettings": { + "type": "object", + "title": "ChunkingSettings", + "description": "Chunking settings", + "properties": { + "maxChunkSizeInTokens": { + "type": "integer" + } + } + }, + "CompletionAction": { + "type": "string", + "description": "The completion action.", + "enum": [ + "cleanUpTempAssets", + "keepAllAssets" + ], + "x-ms-enum": { + "name": "IngestionJobCompletionAction", + "modelAsString": true, + "values": [ + { + "name": "keepAllAssets", + "value": "keepAllAssets", + "description": "Will not clean up any of the intermediate assets created during the ingestion process." + }, + { + "name": "cleanUpTempAssets", + "value": "cleanUpTempAssets", + "description": "Will clean up intermediate assets created during the ingestion process." + } + ] + } + }, + "ComputeType": { + "type": "string", + "description": "The compute type.", + "enum": [ + "ServerlessCompute", + "CustomCompute" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true, + "values": [ + { + "name": "ServerlessCompute", + "value": "ServerlessCompute", + "description": "Serverless user compute." + }, + { + "name": "CustomCompute", + "value": "CustomCompute", + "description": "Custom user compute." + } + ] + } + }, + "ConnectionStringConnection": { + "description": "Connection string connection.", + "required": [ + "connectionString" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "connectionString": { + "type": "string", + "description": "Connection string" + } + } + } + ], + "x-ms-discriminator-value": "ConnectionString" + }, + "ConnectionType": { + "type": "string", + "description": "The connection type.", + "enum": [ + "EndpointWithKey", + "ConnectionString", + "EndpointWithManagedIdentity", + "WorkspaceConnection", + "RelativeConnection" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "EndpointWithKey", + "value": "EndpointWithKey", + "description": "Endpoint and key connection." + }, + { + "name": "ConnectionString", + "value": "ConnectionString", + "description": "Connection string." + }, + { + "name": "EndpointWithManagedIdentity", + "value": "EndpointWithManagedIdentity", + "description": "Endpoint and managed identity." + }, + { + "name": "WorkspaceConnection", + "value": "WorkspaceConnection", + "description": "AML Workspace connection." + }, + { + "name": "RelativeConnection", + "value": "RelativeConnection", + "description": "Relative deployment" + } + ] + } + }, + "CosmosDBIndex": { + "description": "CosmosDB Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the cosmos DB." + }, + "collectionName": { + "type": "string", + "description": "The name of the cosmos DB collection." + }, + "databaseName": { + "type": "string", + "description": "The name of the cosmos DB database." + } + } + } + ], + "x-ms-discriminator-value": "CosmosDB" + }, + "CrawlingSettings": { + "type": "object", + "title": "CrawlingSettings", + "description": "Crawling settings", + "properties": { + "maxCrawlDepth": { + "type": "integer" + }, + "maxCrawlTimeInMins": { + "type": "integer" + }, + "maxDownloadTimeInMins": { + "type": "integer" + }, + "maxFileSize": { + "type": "integer" + }, + "maxRedirects": { + "type": "integer" + }, + "maxFiles": { + "type": "integer" + } + } + }, + "CustomCompute": { + "description": "Custom compute.", + "required": [ + "computeId" + ], + "allOf": [ + { + "$ref": "#/definitions/JobCompute" + }, + { + "type": "object", + "properties": { + "computeId": { + "type": "string", + "description": "Id of the custom compute" + } + } + } + ], + "x-ms-discriminator-value": "CustomCompute" + }, + "DeploymentConnection": { + "description": "Relative deployment connection.", + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + } + ], + "x-ms-discriminator-value": "RelativeConnection" + }, + "Deprecation": { + "title": "Deprecation", + "description": "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties.", + "required": [ + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "format": "unixtime", + "description": "The end date of fine tune support of this model. Will be `null` for fine tune models.", + "type": "integer" + }, + "inference": { + "format": "unixtime", + "description": "The end date of inference support of this model.", + "type": "integer" + } + } + }, + "DpoHyperparamsRequest": { + "title": "DpoHyperparamsRequest", + "description": "Hyperparameters for DPO method of finetuning", + "type": "object", + "properties": { + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + }, + "beta": { + "format": "double", + "description": "Dpo beta value.", + "type": "number" + }, + "l2_multiplier": { + "format": "double", + "description": "L2 regularization multiplier", + "type": "number" + } + } + }, + "DpoMethod": { + "title": "DpoMethod", + "description": "Request for DPO method finetuning", + "required": [ + "dpo", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FineTuneMethod" + } + ], + "properties": { + "type": { + "$ref": "#/definitions/FineTuningMethodType" + }, + "dpo": { + "$ref": "#/definitions/DpoMethodConfigRequest" + } + } + }, + "DpoMethodConfigRequest": { + "title": "DpoMethodConfigRequest", + "description": "Configuration for dpo finetuning method. Includes DPO specific hyperparameters", + "type": "object", + "properties": { + "hyperparameters": { + "$ref": "#/definitions/DpoHyperparamsRequest" + } + } + }, + "DpoMethodRequest": { + "title": "DpoMethodRequest", + "description": "Request for DPO method finetuning", + "required": [ + "dpo", + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FineTuneMethodRequest" + } + ], + "properties": { + "type": { + "$ref": "#/definitions/FineTuningMethodType" + }, + "dpo": { + "$ref": "#/definitions/DpoMethodConfigRequest" + } + } + }, + "EndpointKeyConnection": { + "description": "Endpoint key connection.", + "required": [ + "endpoint", + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "endpoint": { + "type": "string", + "description": "Endpoint" + }, + "key": { + "type": "string", + "description": "Key" + } + } + } + ], + "x-ms-discriminator-value": "EndpointWithKey" + }, + "EndpointMIConnection": { + "description": "Endpoint Managed Identity connection.", + "required": [ + "endpoint" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "endpoint": { + "type": "string", + "description": "Endpoint" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + } + } + } + ], + "x-ms-discriminator-value": "EndpointWithManagedIdentity" + }, + "Error": { + "title": "Error", + "description": "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The message of this error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "The location where the error happened if available.", + "type": "string" + }, + "details": { + "description": "The error details if available.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "conflict", + "invalidPayload", + "forbidden", + "notFound", + "unexpectedEntityState", + "itemDoesAlreadyExist", + "serviceUnavailable", + "internalFailure", + "quotaExceeded", + "jsonlValidationFailed", + "fileImportFailed", + "tooManyRequests", + "unauthorized", + "contentFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "conflict", + "description": "The requested operation conflicts with the current resource state." + }, + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + }, + { + "value": "forbidden", + "description": "The operation is forbidden for the current user/api key." + }, + { + "value": "notFound", + "description": "The resource is not found." + }, + { + "value": "unexpectedEntityState", + "description": "The operation cannot be executed in the current resource's state." + }, + { + "value": "itemDoesAlreadyExist", + "description": "The item does already exist." + }, + { + "value": "serviceUnavailable", + "description": "The service is currently not available." + }, + { + "value": "internalFailure", + "description": "Internal error. Please retry." + }, + { + "value": "quotaExceeded", + "description": "Quota exceeded." + }, + { + "value": "jsonlValidationFailed", + "description": "Validation of jsonl data failed." + }, + { + "value": "tooManyRequests", + "description": "Too many requests. Please retry later." + }, + { + "value": "unauthorized", + "description": "The current user/api key is not authorized for the operation." + }, + { + "value": "contentFilter", + "description": "Image generation failed as a result of our safety system." + }, + { + "value": "fileImportFailed", + "description": "Import of file failed." + } + ] + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EventType": { + "title": "EventType", + "description": "Defines the severity of a content filter result.", + "enum": [ + "message", + "metrics" + ], + "type": "string", + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "message", + "description": "Event only contains human readable messages." + }, + { + "value": "metrics", + "description": "Event contains metrics." + } + ] + } + }, + "File": { + "title": "File", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FileState" + }, + "bytes": { + "format": "int64", + "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers.", + "type": "integer", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "status_details": { + "description": "The error message with details in case processing of this file failed.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "FileCreate": { + "title": "FileCreate", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileDetails": { + "title": "FileDetails", + "description": "A file detail is a document used by batch service to fetch file blob details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "path": { + "description": "The the relative path to the file within the container.", + "type": "string", + "readOnly": true + }, + "storage_account_uri": { + "format": "url", + "description": "The storage account url of this file.", + "type": "string", + "readOnly": true + }, + "storage_container_name": { + "description": "The Storage Container Name of this file blob.", + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + } + } + }, + "FileDelete": { + "title": "FileDelete", + "description": "Defines the response for File Delete.", + "required": [ + "deleted", + "id", + "object" + ], + "type": "object", + "properties": { + "object": { + "description": "The file object.", + "minLength": 1, + "type": "string" + }, + "deleted": { + "description": "A value indicating whether the file was deleted.", + "type": "boolean" + }, + "id": { + "description": "The file-id that was deleted.", + "minLength": 1, + "type": "string" + } + } + }, + "FileImport": { + "title": "FileImport", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "filename", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples.", + "minLength": 1, + "type": "string" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileState": { + "title": "FileState", + "description": "The state of a file.", + "enum": [ + "uploaded", + "pending", + "running", + "processed", + "error", + "deleting", + "deleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FileState", + "modelAsString": true, + "values": [ + { + "value": "uploaded", + "description": "The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "processed", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "error", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + }, + { + "value": "deleting", + "description": "The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state." + }, + { + "value": "deleted", + "description": "The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state." + } + ] + } + }, + "FileList": { + "title": "FileList", + "description": "Represents a list of files.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + } + } + }, + "FineTuneMethod": { + "title": "FineTuneMethod", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FineTuningMethodType" + } + }, + "discriminator": "type" + }, + "FineTuneMethodRequest": { + "title": "FineTuneMethodRequest", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/FineTuningMethodType" + } + }, + "discriminator": "type" + }, + "FineTuningHyperParameters": { + "title": "FineTuningHyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + } + } + }, + "FineTuningJob": { + "title": "FineTuningJob", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The identifier (model-id) of the base model used for the fine-tune.", + "minLength": 1, + "type": "string" + }, + "fine_tuned_model": { + "description": "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing.", + "type": "string" + }, + "training_file": { + "description": "The file which is used for training.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file which is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "result_files": { + "description": "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs.", + "type": "array", + "items": { + "type": "string" + } + }, + "finished_at": { + "format": "int32", + "description": "A timestamp when this job or item has finished successfully (in unix epochs).", + "type": "integer" + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "trained_tokens": { + "format": "int32", + "description": "The total number of billable tokens processed by this fine tuning job.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/FineTuningJobError" + }, + "estimated_finish": { + "format": "int32", + "description": "The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.", + "type": "integer" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job.", + "type": "integer" + }, + "integrations": { + "description": "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type.", + "type": "array", + "items": { + "$ref": "#/definitions/WandBIntegrationRequestWrapper" + } + }, + "method": { + "title": "FineTuneMethod", + "description": "A configuration for finetuning method for the finetuning job. Currently 'dpo' and 'supervised' methods are supported.", + "allOf": [ + { + "$ref": "#/definitions/SupervisedMethod" + } + ] + } + } + }, + "FineTuningJobCheckpoint": { + "title": "FineTuningJobCheckpoint", + "required": [ + "created_at", + "fine_tuned_model_checkpoint", + "fine_tuning_job_id", + "metrics", + "step_number" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this checkpoint.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the checkpoint was created.", + "type": "integer" + }, + "fine_tuned_model_checkpoint": { + "description": "The name of the fine-tuned checkpoint model that is created.", + "minLength": 1, + "type": "string" + }, + "step_number": { + "format": "int32", + "description": "The step number that the checkpoint was created at.", + "type": "integer" + }, + "metrics": { + "title": "Dictionary`2", + "description": "The metrics at the step number during the fine-tuning job.", + "type": "object", + "additionalProperties": { + "format": "double", + "type": "number" + } + }, + "fine_tuning_job_id": { + "description": "The name of the fine-tuning job that this checkpoint was created from..", + "minLength": 1, + "type": "string" + } + } + }, + "FineTuningJobCheckpointList": { + "title": "FineTuningJobCheckpointList", + "description": "Represents a list of checkpoints.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobCheckpoint" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobCreation": { + "title": "FineTuningJobCreation", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "model": { + "description": "The identifier (model-id) of the base model used for this fine-tune.", + "minLength": 1, + "type": "string" + }, + "training_file": { + "description": "The file identity (file-id) that is used for training this fine tuned model.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file identity (file-id) that is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.", + "type": "integer" + }, + "integrations": { + "description": "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type.", + "type": "array", + "items": { + "$ref": "#/definitions/WandBIntegrationRequestWrapper" + } + }, + "method": { + "title": "FineTuneMethodRequest", + "description": "A configuration for finetuning method for the finetuning job. Currently 'dpo' and 'supervised' methods are supported.", + "allOf": [ + { + "$ref": "#/definitions/SupervisedMethodRequest" + } + ] + } + } + }, + "FineTuningJobError": { + "title": "FineTuningJobError", + "description": "For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.", + "type": "object", + "properties": { + "code": { + "description": "The machine-readable error code..", + "type": "string" + }, + "message": { + "description": "The human-readable error message.", + "type": "string" + }, + "param": { + "description": "The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.", + "type": "string" + } + } + }, + "FineTuningJobEvent": { + "title": "FineTuningJobEvent", + "required": [ + "created_at", + "level", + "message", + "type" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this event.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this event was created (in unix epochs).", + "type": "integer" + }, + "level": { + "$ref": "#/definitions/LogLevel" + }, + "message": { + "description": "The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.", + "minLength": 1, + "type": "string" + }, + "type": { + "$ref": "#/definitions/EventType" + }, + "data": { + "description": "Machine readable data of this event." + } + } + }, + "FineTuningJobEventList": { + "title": "FineTuningJobEventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobEvent" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobList": { + "title": "FineTuningJobList", + "description": "Represents a list of fine tunes.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningMethodType": { + "title": "FineTuningMethodType", + "enum": [ + "dpo", + "supervised" + ], + "type": "string", + "x-ms-enum": { + "name": "FineTuningMethodType", + "modelAsString": true, + "values": [ + { + "value": "dpo", + "description": "Finetunes using Dpo algorithm" + }, + { + "value": "supervised", + "description": "Finetunes using Supervised algorithm" + } + ] + } + }, + "FineTuningState": { + "title": "FineTuningState", + "description": "The state of a finetunes object or fine tuning job.", + "enum": [ + "created", + "pending", + "running", + "succeeded", + "cancelled", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FineTuningState", + "modelAsString": true, + "values": [ + { + "value": "created", + "description": "The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation is not yet queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "cancelled", + "description": "The operation has been cancelled and is incomplete. It can be categorized as a terminal state." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + } + ] + } + }, + "GenericEmbeddingSettings": { + "title": "ConnectionEmbeddingSettings", + "description": "Connection Embedding Settings", + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "deploymentName": { + "type": "string" + }, + "modelName": { + "type": "string" + } + } + }, + "IngestionError": { + "title": "IngestionError", + "description": "The details of the ingestion error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "innerErrors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IngestionJob": { + "title": "IngestionJob", + "description": "Represents the details of a job.", + "type": "object", + "required": [ + "kind" + ], + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/IngestionJobType" + }, + "jobId": { + "type": "string" + } + } + }, + "IngestionJobList": { + "title": "IngestionJobList", + "description": "Represents a list of ingestion jobs.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page.", + "type": "string" + }, + "value": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJob" + } + } + } + }, + "IngestionJobProgress": { + "title": "IngestionJobProgress", + "type": "object", + "required": [ + "stageProgress" + ], + "properties": { + "stageProgress": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobStageProgress" + } + } + } + }, + "IngestionJobRun": { + "title": "IngestionJobRun", + "description": "The details of a job run", + "type": "object", + "properties": { + "jobId": { + "type": "string" + }, + "runId": { + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationState" + }, + "error": { + "$ref": "#/definitions/IngestionError" + }, + "warnings": { + "type": "array", + "items": { + "type": "string" + } + }, + "progress": { + "$ref": "#/definitions/IngestionJobProgress" + } + } + }, + "IngestionJobRunList": { + "title": "IngestionJobRunList", + "description": "Represents a list of ingestion job runs.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page.", + "type": "string" + }, + "value": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobRun" + } + } + } + }, + "IngestionJobStageProgress": { + "title": "IngestionJobStageProgress", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "totalItems": { + "type": "integer", + "format": "int32" + }, + "processedItems": { + "type": "integer", + "format": "int32" + }, + "state": { + "$ref": "#/definitions/OperationState" + }, + "subStageProgress": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobStageProgress" + } + } + } + }, + "IngestionJobSystemCompute": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IngestionJob" + }, + { + "type": "object", + "properties": { + "searchServiceConnection": { + "$ref": "#/definitions/BaseConnection" + }, + "datasource": { + "$ref": "#/definitions/SystemComputeDatasource" + }, + "completionAction": { + "$ref": "#/definitions/CompletionAction" + }, + "dataRefreshIntervalInHours": { + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "SystemCompute" + }, + "IngestionJobType": { + "title": "IngestionJobType", + "type": "string", + "description": "The job type.", + "enum": [ + "SystemCompute", + "UserCompute" + ], + "x-ms-enum": { + "name": "IngestionJobType", + "modelAsString": true, + "values": [ + { + "name": "SystemCompute", + "value": "SystemCompute", + "description": "Jobs that run on service owned resources." + }, + { + "name": "UserCompute", + "value": "UserCompute", + "description": "Jobs that run on user owned workspace." + } + ] + } + }, + "IngestionJobUserCompute": { + "type": "object", + "required": [ + "workspaceId" + ], + "allOf": [ + { + "$ref": "#/definitions/IngestionJob" + }, + { + "type": "object", + "properties": { + "workspaceId": { + "type": "string" + }, + "compute": { + "$ref": "#/definitions/JobCompute" + }, + "target": { + "$ref": "#/definitions/TargetIndex" + }, + "datasource": { + "$ref": "#/definitions/UserComputeDatasource" + }, + "dataRefreshIntervalInHours": { + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "UserCompute" + }, + "InnerError": { + "title": "InnerError", + "description": "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerErrorCode": { + "title": "InnerErrorCode", + "description": "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "invalidPayload" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + } + ] + } + }, + "IntegrationTypes": { + "title": "IntegrationTypes", + "description": "List of Fine Tune integrations available.", + "enum": [ + "wandb" + ], + "type": "string" + }, + "JobCompute": { + "title": "JobCompute", + "description": "The compute settings of the job.", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ComputeType" + } + } + }, + "LifeCycleStatus": { + "title": "LifeCycleStatus", + "description": "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\".", + "enum": [ + "preview", + "generally-available" + ], + "type": "string", + "x-ms-enum": { + "name": "LifeCycleStatus", + "modelAsString": true, + "values": [ + { + "value": "preview", + "description": "Model is in preview and covered by the service preview terms." + }, + { + "value": "generally-available", + "description": "Model is generally available." + } + ] + } + }, + "LogLevel": { + "title": "LogLevel", + "description": "The verbosity level of an event.", + "enum": [ + "info", + "warning", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true, + "values": [ + { + "value": "info", + "description": "This event is for information only." + }, + { + "value": "warning", + "description": "This event represents a mitigated issue." + }, + { + "value": "error", + "description": "This message represents a non recoverable issue." + } + ] + } + }, + "Model": { + "title": "Model", + "description": "A model is either a base model or the result of a successful fine tune job.", + "required": [ + "capabilities", + "deprecation", + "lifecycle_status" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The base model identity (model-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "fine_tune": { + "description": "The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "capabilities": { + "$ref": "#/definitions/Capabilities" + }, + "lifecycle_status": { + "$ref": "#/definitions/LifeCycleStatus" + }, + "deprecation": { + "$ref": "#/definitions/Deprecation" + } + } + }, + "ModelList": { + "title": "ModelList", + "description": "Represents a list of models.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "OperationState": { + "title": "OperationState", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation is not yet queued to be processed in the future." + }, + { + "value": "running", + "description": "The operation has started to be processed." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "PineconeIndex": { + "description": "Pinecone Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the pinecone." + } + } + } + ], + "x-ms-discriminator-value": "Pinecone" + }, + "Purpose": { + "title": "Purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + "ServerlessCompute": { + "description": "Serverless compute.", + "allOf": [ + { + "$ref": "#/definitions/JobCompute" + }, + { + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "SKU Level" + }, + "instanceCount": { + "type": "integer", + "description": "The count of instances to run the job on." + } + } + } + ], + "x-ms-discriminator-value": "ServerlessCompute" + }, + "SystemComputeDatasource": { + "title": "SystemComputeDatasource", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/SystemComputeDatasourceType" + } + }, + "discriminator": "kind" + }, + "SystemComputeDatasourceType": { + "type": "string", + "description": "The datasource type.", + "enum": [ + "Storage", + "Urls" + ], + "x-ms-enum": { + "name": "SystemComputeDatasourceType", + "modelAsString": true, + "values": [ + { + "name": "Storage", + "value": "Storage", + "description": "Azure Storage Account." + }, + { + "name": "Urls", + "value": "Urls", + "description": "URLs." + } + ] + } + }, + "SystemComputeStorage": { + "title": "SystemComputeStorage", + "description": "Storage account", + "required": [ + "connection", + "containerName", + "embeddings" + ], + "x-ms-discriminator-value": "Storage", + "allOf": [ + { + "$ref": "#/definitions/SystemComputeDatasource" + }, + { + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "containerName": { + "type": "string", + "description": "container name" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericEmbeddingSettings" + } + } + } + } + ] + }, + "SystemComputeUrl": { + "title": "SystemComputeUrl", + "description": "Urls", + "required": [ + "urls", + "connection", + "containerName", + "embeddings" + ], + "x-ms-discriminator-value": "Urls", + "allOf": [ + { + "$ref": "#/definitions/SystemComputeDatasource" + }, + { + "type": "object", + "properties": { + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "containerName": { + "type": "string", + "description": "container name" + }, + "crawling": { + "$ref": "#/definitions/CrawlingSettings" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericEmbeddingSettings" + } + } + } + } + ] + }, + "SupervisedMethod": { + "title": "SupervisedMethod", + "description": "Method used for supervised finetuning", + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FineTuneMethod" + } + ], + "properties": { + "type": { + "$ref": "#/definitions/FineTuningMethodType" + } + } + }, + "SupervisedMethodRequest": { + "title": "SupervisedMethodRequest", + "description": "Method used for supervised finetuning", + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FineTuneMethodRequest" + } + ], + "properties": { + "type": { + "$ref": "#/definitions/FineTuningMethodType" + } + } + }, + "TargetIndex": { + "title": "TargetIndex", + "description": "Information about the index to be created.", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/TargetType" + } + } + }, + "TargetType": { + "type": "string", + "description": "The target type.", + "enum": [ + "AzureAISearch", + "CosmosDB", + "Pinecone" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true, + "values": [ + { + "name": "AzureAISearch", + "value": "AzureAISearch", + "description": "Azure AI Search Index." + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB Index." + }, + { + "name": "Pinecone", + "value": "Pinecone", + "description": "Pinecone Index." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine_tuning.job", + "file", + "fine_tuning.job.event", + "fine_tuning.job.checkpoint", + "model", + "upload", + "upload.part", + "batch" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TypeDiscriminator", + "modelAsString": true, + "values": [ + { + "value": "list", + "description": "This object represents a list of other objects." + }, + { + "value": "fine_tuning.job", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine_tuning.job.event", + "description": "This object represents an event of a fine tuning job." + }, + { + "value": "fine_tuning.job.checkpoint", + "description": "This object represents a checkpoint of a fine tuning job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base model or fine tune job result)." + }, + { + "value": "upload", + "description": "This object represents a file upload." + }, + { + "value": "upload.part", + "description": "This object represents part of a file upload." + }, + { + "value": "wandb", + "description": "This object represents the Weights and Biases Integration configuration." + }, + { + "value": "batch", + "description": "This object represents a batch." + } + ] + } + }, + "UploadFileCompleteBody": { + "title": "UploadFileCompleteBody", + "required": [ + "part_ids" + ], + "type": "object", + "properties": { + "part_ids": { + "title": "IList`1", + "type": "array", + "items": { + "type": "string" + } + }, + "md5": { + "type": "string" + } + } + }, + "UploadFileStartBody": { + "title": "UploadFileStartBody", + "required": [ + "bytes", + "filename", + "mime_type", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "minLength": 1, + "type": "string" + }, + "bytes": { + "format": "int64", + "type": "integer" + }, + "mime_type": { + "minLength": 1, + "type": "string" + } + } + }, + "UploadPartResource": { + "title": "UploadPartResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "upload_id": { + "type": "string", + "readOnly": true + }, + "azure_block_id": { + "type": "string", + "readOnly": true + } + } + }, + "UploadResource": { + "title": "UploadResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "type": "integer", + "readOnly": true + }, + "filename": { + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "status": { + "$ref": "#/definitions/UploadStatus" + }, + "expires_at": { + "format": "unixtime", + "type": "integer", + "readOnly": true + }, + "file": { + "$ref": "#/definitions/File" + } + } + }, + "UploadStatus": { + "title": "UploadStatus", + "enum": [ + "pending", + "expired", + "completed", + "cancelled" + ], + "type": "string", + "readOnly": true + }, + "UserComputeDataset": { + "type": "object", + "title": "UserComputeStorage", + "description": "Storage account", + "required": [ + "datasetId", + "datasetType" + ], + "x-ms-discriminator-value": "Dataset", + "allOf": [ + { + "$ref": "#/definitions/UserComputeDatasource" + }, + { + "type": "object", + "properties": { + "datasetId": { + "type": "string" + }, + "datasetType": { + "type": "string" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionEmbeddingSettings" + } + } + } + } + ] + }, + "UserComputeDatasource": { + "title": "UserComputeDatasource", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/UserComputeDatasourceType" + } + } + }, + "UserComputeDatasourceType": { + "type": "string", + "description": "The datasource type.", + "enum": [ + "Dataset", + "Urls" + ], + "x-ms-enum": { + "name": "UserComputeDatasourceType", + "modelAsString": true, + "values": [ + { + "name": "Dataset", + "value": "Dataset", + "description": "Workspace Dataset." + }, + { + "name": "Urls", + "value": "Urls", + "description": "URLs." + } + ] + } + }, + "UserComputeUrl": { + "type": "object", + "title": "UserComputeUrl", + "description": "Urls", + "required": [ + "urls", + "embeddings" + ], + "x-ms-discriminator-value": "Urls", + "allOf": [ + { + "$ref": "#/definitions/UserComputeDatasource" + }, + { + "type": "object", + "properties": { + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "crawling": { + "$ref": "#/definitions/CrawlingSettings" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionEmbeddingSettings" + } + } + } + } + ] + }, + "WandBIntegrationRequest": { + "title": "WandBIntegrationRequest", + "required": [ + "project" + ], + "type": "object", + "properties": { + "project": { + "minLength": 1, + "type": "string" + }, + "name": { + "type": "string", + "readOnly": true + }, + "entity": { + "type": "string", + "readOnly": true + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "WandBIntegrationRequestWrapper": { + "title": "WandBIntegrationRequestWrapper", + "required": [ + "type", + "wandb" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/IntegrationTypes" + }, + "wandb": { + "$ref": "#/definitions/WandBIntegrationRequest" + } + } + }, + "WorkspaceConnection": { + "description": "AML Workspace connection.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "ConnectionId" + } + } + } + ], + "x-ms-discriminator-value": "WorkspaceConnection" + }, + "WorkspaceConnectionEmbeddingSettings": { + "title": "WorkspaceConnectionEmbeddingSettings", + "description": "Connection id to the embedding model", + "type": "object", + "properties": { + "connectionId": { + "type": "string" + }, + "deploymentName": { + "type": "string" + }, + "modelName": { + "type": "string" + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace \"aoairesource\" with your Azure OpenAI account name).", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string", + "x-ms-client-default": "2025-01-01-preview", + "x-ms-parameter-location": "client" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "description": "API key authentication", + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "description": "OAuth2 authentication", + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.yaml new file mode 100644 index 000000000000..e79567988a30 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/azureopenai.yaml @@ -0,0 +1,2797 @@ +swagger: "2.0" +info: + title: Azure OpenAI API version 2025-01-01-preview + description: APIs for fine-tuning and managing deployments of OpenAI models. + version: 2025-01-01-preview +paths: + /batches: + get: + tags: + - "Batch:" + summary: Gets a list of all batches owned by the Azure OpenAI resource. + operationId: Batch_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of batches to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - in: query + name: $filter + description: The OData expression to describe the filtering conditions. + type: string + - in: query + name: $orderby + description: The OData expression to describe the sorting order. + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/BatchesList" + headers: + deployment-enqueued-tokens: + description: Sum of enqueued tokens of all jobs that target to the deployment. + type: integer + format: int64 + deployment-maximum-enqueued-tokens: + description: Maximum enqueued tokens of the deployment. + type: integer + format: int64 + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all batches owned by this account.: + $ref: ./examples/get_batches.json + post: + tags: + - "Batch:" + summary: "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete." + operationId: Batch_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: createBatchRequest + description: The specification of the batch to create and execute. + required: true + schema: + $ref: "#/definitions/BatchCreateRequest" + responses: + "201": + description: The batch has been successfully created. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a batch.: + $ref: ./examples/post_batch.json + /batches/{batch-id}: + get: + tags: + - "Batch:" + summary: Gets details for a single batch specified by the given batch-id. + operationId: Batch_Get + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a batch.: + $ref: ./examples/get_batch.json + /batches/{batch-id}/cancel: + post: + tags: + - "Batch:" + summary: Cancels the processing of the batch specified by the given batch-id. + operationId: Batch_Cancel + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The batch has been successfully canceled. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a batch.: + $ref: ./examples/cancel_batch.json + /files: + get: + tags: + - "Files:" + summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job." + operationId: Files_List + produces: + - application/json + parameters: + - in: query + name: purpose + description: Only return files with the given purpose. + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - value: batch_output + description: This file contains the results of a batch. + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FileList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all files owned by this account.: + $ref: ./examples/get_files.yaml + post: + tags: + - "Files:" + summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Upload + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + required: true + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - in: formData + name: file + description: Gets or sets the file to upload into Azure OpenAI. + required: true + type: file + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a file.: + $ref: ./examples/upload_file.yaml + /files/import: + post: + tags: + - "Files:" + summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Import + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fileImport + description: The definition of the file to create including its purpose, the file name and the url of the file location. + required: true + schema: + $ref: "#/definitions/FileImport" + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Importing a file with a blob url as source.: + $ref: ./examples/import_file.yaml + /files/{file-id}: + get: + tags: + - "Files:" + summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc. + operationId: Files_Get + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/File" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a file.: + $ref: ./examples/get_file.yaml + delete: + tags: + - "Files:" + summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job." + operationId: Files_Delete + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The file was successfully deleted. + schema: + $ref: '#/definitions/FileDelete' + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a file.: + $ref: ./examples/delete_file.yaml + /files/{file-id}/content: + get: + tags: + - "Files:" + summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job." + operationId: Files_GetContent + produces: + - application/octet-stream + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + type: file + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting the file content.: + $ref: ./examples/get_file_content.yaml + /fine_tuning/jobs: + get: + tags: + - "Fine-tuning:" + summary: "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all fine tuning jobs owned by this account.: + $ref: ./examples/get_finetuning_jobs.yaml + post: + tags: + - "Fine-tuning:" + summary: "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete." + operationId: FineTuning_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fineTuningJob + description: "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others." + required: true + schema: + $ref: "#/definitions/FineTuningJobCreation" + responses: + "201": + description: The fine tune has been successfully created. + schema: + $ref: "#/definitions/FineTuningJob" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a fine tuning job.: + $ref: ./examples/post_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}: + get: + tags: + - "Fine-tuning:" + summary: "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_Get + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a fine tuning job.: + $ref: ./examples/get_finetuning_job.yaml + delete: + tags: + - "Fine-tuning:" + summary: Deletes the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Delete + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "204": + description: The fine tune was successfully deleted. + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a fine tuning job.: + $ref: ./examples/delete_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/cancel: + post: + tags: + - "Fine-tuning:" + summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Cancel + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The fine tune has been successfully canceled + schema: + $ref: "#/definitions/FineTuningJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a fine tuning job.: + $ref: ./examples/cancel_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints: + get: + tags: + - "Fine-tuning:" + summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training." + operationId: FineTuning_GetCheckpoints + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last checkpoint ID from the previous pagination request. + type: string + - in: query + name: limit + description: Number of checkpoints to retrieve. Defaults to 10. + type: integer + format: int32 + default: 10 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobCheckpointList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting checkpoints of a fine tuning job.: + $ref: ./examples/get_finetuning_job_checkpoints.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/events: + get: + tags: + - "Fine-tuning:" + summary: "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_GetEvents + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobEventList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting events of a fine tuning job.: + $ref: ./examples/get_finetuning_job_events.yaml + /ingestion/jobs: + get: + tags: + - "Ingestion:" + summary: Lists the ingestion jobs. + operationId: IngestionJobs_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + List all ingestion jobs: + $ref: ./examples/list_ingestion_jobs.json + /ingestion/jobs/{job-id}: + put: + tags: + - "Ingestion:" + summary: Creates an ingestion job with the specified job id. + operationId: IngestionJobs_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + type: string + description: The id of the job that will be created. + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + - in: header + name: aml-user-token + type: string + description: The token used to access the resources within the job in the workspace (needed only for user compute jobs). + - in: body + name: ingestionJob + schema: + $ref: "#/definitions/IngestionJob" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Create a system-compute ingestion job: + $ref: ./examples/put_ingestion_job_sc.json + Create a user-compute ingestion job: + $ref: ./examples/put_ingestion_job_uc.json + get: + tags: + - "Ingestion:" + summary: Gets the details of the specified job id. + operationId: IngestionJobs_Get + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Get ingestion job: + $ref: ./examples/get_ingestion_job.json + /ingestion/jobs/{job-id}/runs: + get: + tags: + - "Ingestion:" + summary: Lists the runs of the specified job id. + operationId: IngestionJobRuns_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobRunList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + List ingestion job runs: + $ref: ./examples/list_ingestion_job_runs.json + /ingestion/jobs/{job-id}/runs/{run-id}: + get: + tags: + - "Ingestion:" + summary: Gets the details of the specified run id as part of the specified job id. + operationId: IngestionJobRuns_Get + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + - in: path + name: run-id + required: true + description: The id of the run. + type: string + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobRun" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Get ingestion job runs: + $ref: ./examples/get_ingestion_job_run.json + /models: + get: + tags: + - "Models:" + summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource." + operationId: Models_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/ModelList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all models owned by account.: + $ref: ./examples/get_models.yaml + /models/{model-id}: + get: + tags: + - "Models:" + summary: Gets details for the model specified by the given modelId. + operationId: Models_Get + produces: + - application/json + parameters: + - in: path + name: model-id + description: The identifier of the model. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Model" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a base model.: + $ref: ./examples/get_model_base.yaml + Getting a fine-tuned model.: + $ref: ./examples/get_model_finetune.yaml + /uploads: + post: + tags: + - "UploadFile:" + summary: "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file." + operationId: UploadFile_Start + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: "#/definitions/UploadFileStartBody" + responses: + "200": + description: The upload has been successfully created. + schema: + $ref: "#/definitions/UploadResource" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Start a large file upload operation.: + $ref: ./examples/upload_file_start.yaml + /uploads/{upload-id}/cancel: + post: + tags: + - "UploadFile:" + summary: "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled." + operationId: UploadFile_Cancel + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Cancel a large file upload operation.: + $ref: ./examples/upload_file_cancel.yaml + /uploads/{upload-id}/complete: + post: + tags: + - "UploadFile:" + summary: "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed." + operationId: UploadFile_Complete + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: "#/definitions/UploadFileCompleteBody" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Complete and validate a large file upload operation.: + $ref: ./examples/upload_file_complete.yaml + /uploads/{upload-id}/parts: + post: + tags: + - "UploadFile:" + summary: "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB." + operationId: UploadFile_Part + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: data + required: true + type: file + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadPartResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a part of large file upload operation.: + $ref: ./examples/upload_file_part.yaml +definitions: + AzureAISearchIndex: + description: Azure AI Search Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the Azure AI Search Index. + x-ms-discriminator-value: AzureAISearch + BaseConnection: + title: BaseConnection + description: A connection to a resource. + type: object + required: + - kind + properties: + kind: + $ref: "#/definitions/ConnectionType" + discriminator: kind + Batch: + title: Batch + description: Defines the values of a batch. + required: + - id + - input_file_id + type: object + properties: + id: + description: The identity of this item. + type: string + object: + $ref: "#/definitions/TypeDiscriminator" + endpoint: + description: The API endpoint used by the batch. + type: string + readOnly: true + errors: + $ref: "#/definitions/BatchErrors" + input_file_id: + description: The ID of the input file for the batch. + minLength: 1 + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + status: + $ref: "#/definitions/BatchStatus" + output_file_id: + description: The ID of the file containing outputs of successfully executed requests. + type: string + error_file_id: + description: The ID of the file containing outputs of requests with errors. + type: string + created_at: + format: unixtime + description: A timestamp when this batch was created (in unix epochs). + type: integer + readOnly: true + in_progress_at: + format: unixtime + description: A timestamp when this batch started progressing (in unix epochs). + type: integer + readOnly: true + expires_at: + format: unixtime + description: A timestamp when this batch will expire (in unix epochs). + type: integer + readOnly: true + finalizing_at: + format: unixtime + description: A timestamp when this batch started finalizing (in unix epochs). + type: integer + readOnly: true + completed_at: + format: unixtime + description: A timestamp when this batch was completed (in unix epochs). + type: integer + readOnly: true + failed_at: + format: unixtime + description: A timestamp when this batch failed (in unix epochs). + type: integer + readOnly: true + expired_at: + format: unixtime + description: A timestamp when this batch expired (in unix epochs). + type: integer + readOnly: true + cancelling_at: + format: unixtime + description: A timestamp when this batch started cancelling (in unix epochs). + type: integer + readOnly: true + cancelled_at: + format: unixtime + description: A timestamp when this batch was cancelled (in unix epochs). + type: integer + readOnly: true + request_counts: + $ref: "#/definitions/BatchRequestCounts" + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchCreateRequest: + title: BatchCreateRequest + description: Defines the request to create a batch. + required: + - input_file_id + - endpoint + - completion_window + type: object + properties: + input_file_id: + description: The ID if the input file for the batch. + minLength: 1 + type: string + endpoint: + description: The API endpoint used by the batch. + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchErrorData: + title: BatchErrorData + description: Error information for a failure in batch. + type: object + properties: + code: + description: An error code identifying the error type. + type: string + message: + description: A human-readable message providing more details about the error. + type: string + param: + description: The name of the parameter that caused the error, if applicable (can be null). + type: string + line: + description: The line number of the input file where the error occurred, if applicable (can be null). + type: string + BatchErrors: + title: BatchErrors + description: For batches that have failed, this will contain more information on the cause of the failures. + type: object + properties: + object: + description: The type of the errors object. This is always 'list'. + type: string + data: + $ref: "#/definitions/BatchErrorData" + BatchRequestCounts: + title: BatchRequestCounts + description: The request counts for different statuses within the batch. + type: object + properties: + total: + description: The total number of requests in the batch. + type: integer + completed: + description: The number of requests in the batch that have been completed successfully. + type: integer + failed: + description: The number of requests in the batch that have failed. + type: integer + BatchStatus: + title: BatchStatus + description: The status of a batch. + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + type: string + readOnly: true + x-ms-enum: + name: BatchStatus + modelAsString: true + values: + - value: validating + description: The input file is being validated before the batch can begin. + - value: failed + description: The input file has failed the validation process. + - value: in_progress + description: The input file was successfully validated and the batch is currently being executed. + - value: finalizing + description: The batch has completed and the results are being prepared. + - value: completed + description: The batch has been completed and the results are ready. + - value: expired + description: The batch was not able to complete within the 24-hour time window. + - value: cancelling + description: Cancellation of the batch has been initiated. + - value: cancelled + description: The batch was cancelled. + BatchesList: + title: BatchList + description: Represents a list of batches. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Batch" + first_id: + description: The id of the first batch in the list of batches returned. + type: string + last_id: + description: The id of the last batch in the list of batches returned. + type: string + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + Capabilities: + title: Capabilities + description: The capabilities of a base or fine tune model. + required: + - chat_completion + - completion + - embeddings + - fine_tune + - inference + type: object + properties: + fine_tune: + description: A value indicating whether a model can be used for fine tuning. + type: boolean + inference: + description: A value indicating whether a model can be deployed. + type: boolean + completion: + description: A value indicating whether a model supports completion. + type: boolean + chat_completion: + description: A value indicating whether a model supports chat completion. + type: boolean + embeddings: + description: A value indicating whether a model supports embeddings. + type: boolean + ChunkingSettings: + type: object + title: ChunkingSettings + description: Chunking settings + properties: + maxChunkSizeInTokens: + type: integer + CompletionAction: + type: string + description: The completion action. + enum: + - cleanUpTempAssets + - keepAllAssets + x-ms-enum: + name: IngestionJobCompletionAction + modelAsString: true + values: + - name: keepAllAssets + value: keepAllAssets + description: Will not clean up any of the intermediate assets created during the ingestion process. + - name: cleanUpTempAssets + value: cleanUpTempAssets + description: Will clean up intermediate assets created during the ingestion process. + ComputeType: + type: string + description: The compute type. + enum: + - ServerlessCompute + - CustomCompute + x-ms-enum: + name: ComputeType + modelAsString: true + values: + - name: ServerlessCompute + value: ServerlessCompute + description: Serverless user compute. + - name: CustomCompute + value: CustomCompute + description: Custom user compute. + ConnectionStringConnection: + description: Connection string connection. + required: + - connectionString + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + connectionString: + type: string + description: Connection string + x-ms-discriminator-value: ConnectionString + ConnectionType: + type: string + description: The connection type. + enum: + - EndpointWithKey + - ConnectionString + - EndpointWithManagedIdentity + - WorkspaceConnection + - RelativeConnection + x-ms-enum: + name: ConnectionType + modelAsString: true + values: + - name: EndpointWithKey + value: EndpointWithKey + description: Endpoint and key connection. + - name: ConnectionString + value: ConnectionString + description: Connection string. + - name: EndpointWithManagedIdentity + value: EndpointWithManagedIdentity + description: Endpoint and managed identity. + - name: WorkspaceConnection + value: WorkspaceConnection + description: AML Workspace connection. + - name: RelativeConnection + value: RelativeConnection + description: Relative deployment + CosmosDBIndex: + description: CosmosDB Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the cosmos DB. + collectionName: + type: string + description: The name of the cosmos DB collection. + databaseName: + type: string + description: The name of the cosmos DB database. + x-ms-discriminator-value: CosmosDB + CrawlingSettings: + type: object + title: CrawlingSettings + description: Crawling settings + properties: + maxCrawlDepth: + type: integer + maxCrawlTimeInMins: + type: integer + maxDownloadTimeInMins: + type: integer + maxFileSize: + type: integer + maxRedirects: + type: integer + maxFiles: + type: integer + CustomCompute: + description: Custom compute. + required: + - computeId + allOf: + - $ref: "#/definitions/JobCompute" + - type: object + properties: + computeId: + type: string + description: Id of the custom compute + x-ms-discriminator-value: CustomCompute + DeploymentConnection: + description: Relative deployment connection. + allOf: + - $ref: "#/definitions/BaseConnection" + x-ms-discriminator-value: RelativeConnection + Deprecation: + title: Deprecation + description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." + required: + - inference + type: object + properties: + fine_tune: + format: unixtime + description: The end date of fine tune support of this model. Will be `null` for fine tune models. + type: integer + inference: + format: unixtime + description: The end date of inference support of this model. + type: integer + DpoHyperparamsRequest: + title: DpoHyperparamsRequest + type: object + properties: + n_epochs: + type: integer + description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. + format: int32 + batch_size: + type: integer + description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model." + format: int32 + learning_rate_multiplier: + type: number + description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results." + format: double + beta: + type: number + description: Dpo beta value. + format: double + l2_multiplier: + type: number + description: L2 regularization multiplier + format: double + description: Hyperparameters for DPO method of finetuning + DpoMethod: + title: DpoMethod + required: + - dpo + - type + type: object + allOf: + - $ref: '#/definitions/FineTuneMethod' + properties: + type: + $ref: '#/definitions/FineTuningMethodType' + dpo: + $ref: '#/definitions/DpoMethodConfigRequest' + description: Request for DPO method finetuning + DpoMethodConfigRequest: + title: DpoMethodConfigRequest + type: object + properties: + hyperparameters: + $ref: '#/definitions/DpoHyperparamsRequest' + description: Configuration for dpo finetuning method. Includes DPO specific hyperparameters + DpoMethodRequest: + title: DpoMethodRequest + required: + - dpo + - type + type: object + allOf: + - $ref: '#/definitions/FineTuneMethodRequest' + properties: + type: + $ref: '#/definitions/FineTuningMethodType' + dpo: + $ref: '#/definitions/DpoMethodConfigRequest' + description: Request for DPO method finetuning + EndpointKeyConnection: + description: Endpoint key connection. + required: + - endpoint + - key + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + endpoint: + type: string + description: Endpoint + key: + type: string + description: Key + x-ms-discriminator-value: EndpointWithKey + EndpointMIConnection: + description: Endpoint Managed Identity connection. + required: + - endpoint + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + endpoint: + type: string + description: Endpoint + resourceId: + type: string + description: Resource Id + x-ms-discriminator-value: EndpointWithManagedIdentity + Error: + title: Error + description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - code + - message + type: object + properties: + code: + $ref: "#/definitions/ErrorCode" + message: + description: The message of this error. + minLength: 1 + type: string + target: + description: The location where the error happened if available. + type: string + details: + description: The error details if available. + type: array + items: + $ref: "#/definitions/Error" + innererror: + $ref: "#/definitions/InnerError" + ErrorCode: + title: ErrorCode + description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - conflict + - invalidPayload + - forbidden + - notFound + - unexpectedEntityState + - itemDoesAlreadyExist + - serviceUnavailable + - internalFailure + - quotaExceeded + - jsonlValidationFailed + - fileImportFailed + - tooManyRequests + - unauthorized + - contentFilter + type: string + x-ms-enum: + name: ErrorCode + modelAsString: true + values: + - value: conflict + description: The requested operation conflicts with the current resource state. + - value: invalidPayload + description: The request data is invalid for this operation. + - value: forbidden + description: The operation is forbidden for the current user/api key. + - value: notFound + description: The resource is not found. + - value: unexpectedEntityState + description: The operation cannot be executed in the current resource's state. + - value: itemDoesAlreadyExist + description: The item does already exist. + - value: serviceUnavailable + description: The service is currently not available. + - value: internalFailure + description: Internal error. Please retry. + - value: quotaExceeded + description: Quota exceeded. + - value: jsonlValidationFailed + description: Validation of jsonl data failed. + - value: fileImportFailed + description: Import of file failed. + - value: tooManyRequests + description: Too many requests. Please retry later. + - value: unauthorized + description: The current user/api key is not authorized for the operation. + - value: contentFilter + description: Image generation failed as a result of our safety system. + ErrorResponse: + title: ErrorResponse + description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - error + type: object + properties: + error: + $ref: "#/definitions/Error" + EventType: + title: EventType + description: Defines the severity of a content filter result. + enum: + - message + - metrics + type: string + x-ms-enum: + name: EventType + modelAsString: true + values: + - value: message + description: Event only contains human readable messages. + - value: metrics + description: Event contains metrics. + File: + title: File + description: A file is a document usable for training and validation. It can also be a service generated document with result details. + required: + - filename + - purpose + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: '#/definitions/FileState' + bytes: + format: int64 + description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers." + type: integer + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + filename: + description: The name of the file. + minLength: 1 + type: string + status_details: + description: The error message with details in case processing of this file failed. + type: string + readOnly: true + readOnly: true + FileCreate: + title: FileCreate + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileDetails: + title: FileDetails + description: A file detail is a document used by batch service to fetch file blob details. + required: + - filename + - purpose + type: object + properties: + id: + description: The identity of this item. + type: string + readOnly: true + filename: + description: The name of the file. + minLength: 1 + type: string + path: + description: The the relative path to the file within the container. + type: string + readOnly: true + storage_account_uri: + format: url + description: The storage account url of this file. + type: string + readOnly: true + storage_container_name: + description: The Storage Container Name of this file blob. + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + FileDelete: + title: FileDelete + required: + - deleted + - id + - object + type: object + properties: + object: + minLength: 1 + type: string + description: The file object. + deleted: + type: boolean + description: A value indicating whether the file was deleted. + id: + minLength: 1 + type: string + description: The file-id that was deleted. + description: Defines the response for File Delete. + FileImport: + title: FileImport + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - filename + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples." + minLength: 1 + type: string + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileList: + title: FileList + description: Represents a list of files. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/File" + FileState: + title: FileState + description: The state of a file. + enum: + - uploaded + - pending + - running + - processed + - error + - deleting + - deleted + type: string + readOnly: true + x-ms-enum: + name: FileState + modelAsString: true + values: + - value: uploaded + description: >- + The file has been uploaded but it's not yet processed. This state is + not returned by Azure OpenAI and exposed only for compatibility. It + can be categorized as an inactive state. + - value: pending + description: >- + The operation was created and is not queued to be processed in the + future. It can be categorized as an inactive state. + - value: running + description: >- + The operation has started to be processed. It can be categorized as + an active state. + - value: processed + description: >- + The operation has successfully be processed and is ready for + consumption. It can be categorized as a terminal state. + - value: error + description: >- + The operation has completed processing with a failure and cannot be + further consumed. It can be categorized as a terminal state. + - value: deleting + description: >- + The entity is ni the process to be deleted. This state is not + returned by Azure OpenAI and exposed only for compatibility. It can + be categorized as an active state. + - value: deleted + description: >- + The entity has been deleted but may still be referenced by other + entities predating the deletion. It can be categorized as a terminal + state. + FineTuneMethod: + title: FineTuneMethod + required: + - kind + type: object + properties: + kind: + $ref: '#/definitions/FineTuningMethodType' + discriminator: kind + FineTuneMethodRequest: + title: FineTuneMethodRequest + required: + - kind + type: object + properties: + kind: + $ref: '#/definitions/FineTuningMethodType' + discriminator: kind + FineTuningHyperParameters: + title: FineTuningHyperParameters + description: The hyper parameter settings used in a fine tune job. + type: object + properties: + n_epochs: + format: int32 + description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. + type: integer + batch_size: + format: int32 + description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model." + type: integer + learning_rate_multiplier: + format: double + description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results." + type: number + FineTuningJob: + title: FineTuningJob + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: "#/definitions/FineTuningState" + model: + description: The identifier (model-id) of the base model used for the fine-tune. + minLength: 1 + type: string + fine_tuned_model: + description: "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing." + type: string + training_file: + description: The file which is used for training. + minLength: 1 + type: string + validation_file: + description: The file which is used to evaluate the fine tuned model during training. + type: string + result_files: + description: "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs." + type: array + items: + type: string + finished_at: + format: int32 + description: A timestamp when this job or item has finished successfully (in unix epochs). + type: integer + organisation_id: + description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. + type: string + trained_tokens: + format: int32 + description: The total number of billable tokens processed by this fine tuning job. + type: integer + readOnly: true + error: + $ref: "#/definitions/FineTuningJobError" + estimated_finish: + format: int32 + description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. + type: integer + hyperparameters: + $ref: "#/definitions/FineTuningHyperParameters" + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. + type: integer + integrations: + type: array + items: + $ref: "#/definitions/WandBIntegrationRequestWrapper" + description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type." + method: + title: FineTuneMethod + enum: + - $ref: '#/definitions/SupervisedMethod' + - $ref: '#/definitions/DpoMethod' + description: A configuration for finetuning method for the finetuning job. Currently 'dpo' and 'supervised' methods are supported. + FineTuningJobCheckpoint: + title: FineTuningJobCheckpoint + required: + - created_at + - fine_tuned_model_checkpoint + - fine_tuning_job_id + - metrics + - step_number + type: object + properties: + object: + $ref: '#/definitions/TypeDiscriminator' + id: + type: string + description: The identity of this checkpoint. + readOnly: true + created_at: + type: integer + description: The Unix timestamp (in seconds) for when the checkpoint was created. + format: unixtime + fine_tuned_model_checkpoint: + minLength: 1 + type: string + description: The name of the fine-tuned checkpoint model that is created. + step_number: + type: integer + description: The step number that the checkpoint was created at. + format: int32 + metrics: + title: Dictionary`2 + type: object + additionalProperties: + type: number + format: double + description: The metrics at the step number during the fine-tuning job. + fine_tuning_job_id: + minLength: 1 + type: string + description: The name of the fine-tuning job that this checkpoint was created from.. + FineTuningJobCheckpointList: + title: FineTuningJobCheckpointList + description: Represents a list of checkpoints. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJobCheckpoint" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobCreation: + title: FineTuningJobCreation + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + model: + description: The identifier (model-id) of the base model used for this fine-tune. + minLength: 1 + type: string + training_file: + description: The file identity (file-id) that is used for training this fine tuned model. + minLength: 1 + type: string + validation_file: + description: The file identity (file-id) that is used to evaluate the fine tuned model during training. + type: string + hyperparameters: + $ref: "#/definitions/FineTuningHyperParameters" + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you. + type: integer + integrations: + type: array + items: + $ref: "#/definitions/WandBIntegrationRequestWrapper" + description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type." + method: + title: FineTuneMethodRequest + enum: + - $ref: '#/definitions/SupervisedMethodRequest' + - $ref: '#/definitions/DpoMethodRequest' + description: A configuration for finetuning method for the finetuning job. Currently 'dpo' and 'supervised' methods are supported. + FineTuningJobError: + title: FineTuningJobError + description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. + type: object + properties: + code: + description: The machine-readable error code.. + type: string + message: + description: The human-readable error message. + type: string + param: + description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. + type: string + FineTuningJobEvent: + title: FineTuningJobEvent + required: + - created_at + - level + - message + - type + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + id: + description: The identity of this event. + type: string + readOnly: true + created_at: + format: unixtime + description: A timestamp when this event was created (in unix epochs). + type: integer + level: + $ref: "#/definitions/LogLevel" + message: + description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results. + minLength: 1 + type: string + type: + $ref: "#/definitions/EventType" + data: + description: Machine readable data of this event. + FineTuningJobEventList: + title: FineTuningJobEventList + description: Represents a list of events. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJobEvent" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobList: + title: FineTuningJobList + description: Represents a list of fine tunes. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJob" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningState: + title: FineTuningState + description: The state of a finetunes object or fine tuning job. + enum: + - created + - pending + - running + - succeeded + - cancelled + - failed + type: string + readOnly: true + x-ms-enum: + name: FineTuningState + modelAsString: true + values: + - value: created + description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: cancelled + description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + FineTuningMethodType: + title: FineTuningMethodType + enum: + - dpo + - supervised + type: string + x-ms-enum: + name: FineTuningMethodType + modelAsString: true + values: + - value: dpo + description: Finetunes using Dpo algorithm + - value: supervised + description: Finetunes using Supervised algorithm + GenericEmbeddingSettings: + title: ConnectionEmbeddingSettings + description: Connection Embedding Settings + type: object + properties: + connection: + $ref: "#/definitions/BaseConnection" + deploymentName: + type: string + modelName: + type: string + IngestionError: + title: IngestionError + description: The details of the ingestion error + type: object + properties: + message: + type: string + innerErrors: + type: array + items: + type: string + IngestionJob: + title: IngestionJob + description: Represents the details of a job. + type: object + required: + - kind + discriminator: kind + properties: + kind: + $ref: "#/definitions/IngestionJobType" + jobId: + type: string + IngestionJobList: + title: IngestionJobList + description: Represents a list of ingestion jobs. + type: object + properties: + nextLink: + description: The link to the next page. + type: string + value: + description: The list of items. + type: array + items: + $ref: "#/definitions/IngestionJob" + IngestionJobProgress: + title: IngestionJobProgress + type: object + required: + - stageProgress + properties: + stageProgress: + type: array + items: + $ref: "#/definitions/IngestionJobStageProgress" + IngestionJobRun: + title: IngestionJobRun + description: The details of a job run + type: object + properties: + jobId: + type: string + runId: + type: string + status: + $ref: "#/definitions/OperationState" + error: + $ref: "#/definitions/IngestionError" + warnings: + type: array + items: + type: string + progress: + $ref: "#/definitions/IngestionJobProgress" + IngestionJobRunList: + title: IngestionJobRunList + description: Represents a list of ingestion job runs. + type: object + properties: + nextLink: + description: The link to the next page. + type: string + value: + description: The list of items. + type: array + items: + $ref: "#/definitions/IngestionJobRun" + IngestionJobStageProgress: + title: IngestionJobStageProgress + type: object + properties: + name: + type: string + totalItems: + type: integer + format: int32 + processedItems: + type: integer + format: int32 + state: + $ref: "#/definitions/OperationState" + subStageProgress: + type: array + items: + $ref: "#/definitions/IngestionJobStageProgress" + IngestionJobSystemCompute: + type: object + allOf: + - $ref: "#/definitions/IngestionJob" + - type: object + properties: + searchServiceConnection: + $ref: "#/definitions/BaseConnection" + datasource: + $ref: "#/definitions/SystemComputeDatasource" + completionAction: + $ref: "#/definitions/CompletionAction" + dataRefreshIntervalInHours: + type: integer + x-ms-discriminator-value: SystemCompute + IngestionJobType: + title: IngestionJobType + type: string + description: The job type. + enum: + - SystemCompute + - UserCompute + x-ms-enum: + name: IngestionJobType + modelAsString: true + values: + - name: SystemCompute + value: SystemCompute + description: Jobs that run on service owned resources. + - name: UserCompute + value: UserCompute + description: Jobs that run on user owned workspace. + IngestionJobUserCompute: + type: object + required: + - workspaceId + allOf: + - $ref: "#/definitions/IngestionJob" + - type: object + properties: + workspaceId: + type: string + compute: + $ref: "#/definitions/JobCompute" + target: + $ref: "#/definitions/TargetIndex" + datasource: + $ref: "#/definitions/UserComputeDatasource" + dataRefreshIntervalInHours: + type: integer + x-ms-discriminator-value: UserCompute + InnerError: + title: InnerError + description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + type: object + properties: + code: + $ref: "#/definitions/InnerErrorCode" + innererror: + $ref: "#/definitions/InnerError" + InnerErrorCode: + title: InnerErrorCode + description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - invalidPayload + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: invalidPayload + description: The request data is invalid for this operation. + IntegrationTypes: + title: IntegrationTypes + enum: + - wandb + type: string + description: List of Fine Tune integrations available. + JobCompute: + title: JobCompute + description: The compute settings of the job. + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/ComputeType" + LifeCycleStatus: + title: LifeCycleStatus + description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"." + enum: + - preview + - generally-available + type: string + x-ms-enum: + name: LifeCycleStatus + modelAsString: true + values: + - value: preview + description: Model is in preview and covered by the service preview terms. + - value: generally-available + description: Model is generally available. + LogLevel: + title: LogLevel + description: The verbosity level of an event. + enum: + - info + - warning + - error + type: string + x-ms-enum: + name: LogLevel + modelAsString: true + values: + - value: info + description: This event is for information only. + - value: warning + description: This event represents a mitigated issue. + - value: error + description: This message represents a non recoverable issue. + Model: + title: Model + description: A model is either a base model or the result of a successful fine tune job. + required: + - capabilities + - deprecation + - lifecycle_status + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: "#/definitions/FineTuningState" + model: + description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. + type: string + fine_tune: + description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. + type: string + capabilities: + $ref: "#/definitions/Capabilities" + lifecycle_status: + $ref: "#/definitions/LifeCycleStatus" + deprecation: + $ref: "#/definitions/Deprecation" + ModelList: + title: ModelList + description: Represents a list of models. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Model" + OperationState: + title: OperationState + description: The state of a job or item. + enum: + - notRunning + - running + - succeeded + - failed + type: string + readOnly: true + x-ms-enum: + name: OperationState + modelAsString: true + values: + - value: notRunning + description: The operation is not yet queued to be processed in the future. + - value: running + description: The operation has started to be processed. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. + PineconeIndex: + description: Pinecone Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the pinecone. + x-ms-discriminator-value: Pinecone + Purpose: + title: Purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + type: string + readOnly: true + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - value: batch_output + description: This file contains the results of a batch. + ServerlessCompute: + description: Serverless compute. + allOf: + - $ref: "#/definitions/JobCompute" + - type: object + properties: + sku: + type: string + description: SKU Level + instanceCount: + type: integer + description: The count of instances to run the job on. + x-ms-discriminator-value: ServerlessCompute + SystemComputeDatasource: + title: SystemComputeDatasource + type: object + required: + - kind + properties: + kind: + $ref: "#/definitions/SystemComputeDatasourceType" + discriminator: kind + SystemComputeDatasourceType: + type: string + description: The datasource type. + enum: + - Storage + - Urls + x-ms-enum: + name: SystemComputeDatasourceType + modelAsString: true + values: + - name: Storage + value: Storage + description: Azure Storage Account. + - name: Urls + value: Urls + description: URLs. + SystemComputeStorage: + title: SystemComputeStorage + description: Storage account + required: + - connection + - containerName + - embeddings + x-ms-discriminator-value: Storage + allOf: + - $ref: "#/definitions/SystemComputeDatasource" + - type: object + properties: + connection: + $ref: "#/definitions/BaseConnection" + containerName: + type: string + description: container name + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/GenericEmbeddingSettings" + SystemComputeUrl: + title: SystemComputeUrl + description: Urls + required: + - urls + - connection + - containerName + - embeddings + x-ms-discriminator-value: Urls + allOf: + - $ref: "#/definitions/SystemComputeDatasource" + - type: object + properties: + urls: + type: array + items: + type: string + connection: + $ref: "#/definitions/BaseConnection" + containerName: + type: string + description: container name + crawling: + $ref: "#/definitions/CrawlingSettings" + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/GenericEmbeddingSettings" + SupervisedMethod: + title: SupervisedMethod + required: + - type + type: object + allOf: + - $ref: '#/definitions/FineTuneMethod' + properties: + type: + $ref: '#/definitions/FineTuningMethodType' + description: Method used for supervised finetuning + SupervisedMethodRequest: + title: SupervisedMethodRequest + required: + - type + type: object + allOf: + - $ref: '#/definitions/FineTuneMethodRequest' + properties: + type: + $ref: '#/definitions/FineTuningMethodType' + description: Method used for supervised finetuning + TargetIndex: + title: TargetIndex + description: Information about the index to be created. + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/TargetType" + TargetType: + type: string + description: The target type. + enum: + - AzureAISearch + - CosmosDB + - Pinecone + x-ms-enum: + name: TargetType + modelAsString: true + values: + - name: AzureAISearch + value: AzureAISearch + description: Azure AI Search Index. + - name: CosmosDB + value: CosmosDB + description: CosmosDB Index. + - name: Pinecone + value: Pinecone + description: Pinecone Index. + TypeDiscriminator: + title: TypeDiscriminator + description: Defines the type of an object. + enum: + - list + - fine_tuning.job + - file + - fine_tuning.job.event + - fine_tuning.job.checkpoint + - model + - upload + - upload.part + - batch + type: string + readOnly: true + x-ms-enum: + name: TypeDiscriminator + modelAsString: true + values: + - value: list + description: This object represents a list of other objects. + - value: fine_tuning.job + description: This object represents a fine tune job. + - value: file + description: This object represents a file. + - value: fine_tuning.job.event + description: This object represents an event of a fine tuning job. + - value: fine_tuning.job.checkpoint + description: This object represents a checkpoint of a fine tuning job. + - value: model + description: This object represents a model (can be a base model or fine tune job result). + - value: upload + description: This object represents a file upload. + - value: upload.part + description: This object represents part of a file upload. + - value: batch + description: This object represents a batch. + UploadFileCompleteBody: + title: UploadFileCompleteBody + required: + - part_ids + type: object + properties: + part_ids: + title: IList`1 + type: array + items: + type: string + md5: + type: string + UploadFileStartBody: + title: UploadFileStartBody + required: + - bytes + - filename + - mime_type + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + minLength: 1 + type: string + bytes: + format: int64 + type: integer + mime_type: + minLength: 1 + type: string + UploadPartResource: + title: UploadPartResource + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + upload_id: + type: string + readOnly: true + azure_block_id: + type: string + readOnly: true + UploadResource: + title: UploadResource + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + bytes: + format: int64 + type: integer + readOnly: true + filename: + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + status: + $ref: "#/definitions/UploadStatus" + expires_at: + format: unixtime + type: integer + readOnly: true + file: + $ref: "#/definitions/File" + UploadStatus: + title: UploadStatus + enum: + - pending + - expired + - completed + - cancelled + type: string + readOnly: true + UserComputeDataset: + type: object + title: UserComputeStorage + description: Storage account + required: + - datasetId + - datasetType + x-ms-discriminator-value: Dataset + allOf: + - $ref: "#/definitions/UserComputeDatasource" + - type: object + properties: + datasetId: + type: string + datasetType: + type: string + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings" + UserComputeDatasource: + title: UserComputeDatasource + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/UserComputeDatasourceType" + UserComputeDatasourceType: + type: string + description: The datasource type. + enum: + - Dataset + - Urls + x-ms-enum: + name: UserComputeDatasourceType + modelAsString: true + values: + - name: Dataset + value: Dataset + description: Workspace Dataset. + - name: Urls + value: Urls + description: URLs. + UserComputeUrl: + type: object + title: UserComputeUrl + description: Urls + required: + - urls + - embeddings + x-ms-discriminator-value: Urls + allOf: + - $ref: "#/definitions/UserComputeDatasource" + - type: object + properties: + urls: + type: array + items: + type: string + crawling: + $ref: "#/definitions/CrawlingSettings" + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings" + WandBIntegrationRequest: + title: WandBIntegrationRequest + required: + - project + type: object + properties: + project: + minLength: 1 + type: string + name: + type: string + readOnly: true + entity: + type: string + readOnly: true + tags: + type: array + items: + type: string + readOnly: true + WandBIntegrationRequestWrapper: + title: WandBIntegrationRequestWrapper + required: + - type + - wandb + type: object + properties: + type: + $ref: '#/definitions/IntegrationTypes' + wandb: + $ref: "#/definitions/WandBIntegrationRequest" + WorkspaceConnection: + description: AML Workspace connection. + required: + - connectionId + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + connectionId: + type: string + description: ConnectionId + x-ms-discriminator-value: WorkspaceConnection + WorkspaceConnectionEmbeddingSettings: + title: WorkspaceConnectionEmbeddingSettings + description: Connection id to the embedding model + type: object + properties: + connectionId: + type: string + deploymentName: + type: string + modelName: + type: string +parameters: + endpoint: + in: path + name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name).' + required: true + type: string + format: url + x-ms-skip-url-encoding: true + x-ms-parameter-location: client + apiVersionQueryParameter: + in: query + name: api-version + description: The requested API version. + required: true + type: string + x-ms-client-default: 2025-01-01-preview + x-ms-parameter-location: client +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +securityDefinitions: + ApiKeyAuth: + description: API key authentication + type: apiKey + name: api-key + in: header + OAuth2Auth: + description: OAuth2 authentication + type: oauth2 + flow: implicit + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: "" +schemes: + - https +x-ms-parameterized-host: + hostTemplate: "{endpoint}/openai" + useSchemePrefix: false + parameters: + - $ref: "#/parameters/endpoint" \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.json new file mode 100644 index 000000000000..6e01ca3fda6e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "cancelling", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": 1646126138, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 100, + "failed": 5 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.yaml new file mode 100644 index 000000000000..7d5534d2da35 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: cancelling + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: 1646126138 + cancelled_at: null + request_counts: + total: 500 + completed: 100 + failed: 5 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.json new file mode 100644 index 000000000000..5bddb4e1f777 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "method": { + "type": "supervised" + }, + "status": "cancelled", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "finished_at": 1646127311, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.yaml new file mode 100644 index 000000000000..30ce827bc636 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/cancel_finetuning_job.yaml @@ -0,0 +1,36 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2025-01-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + method: + type: supervised + status: cancelled + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: 1646127311 + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.json new file mode 100644 index 000000000000..7622dfd4e1a7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "file", + "deleted": true, + "id": "file-181a1cbdcdcf4677ada87f63a0928099" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.yaml new file mode 100644 index 000000000000..a7cf71d53b0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_file.yaml @@ -0,0 +1,12 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + object: file + deleted: true + id: file-181a1cbdcdcf4677ada87f63a0928099 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.json new file mode 100644 index 000000000000..13df47548b6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.yaml new file mode 100644 index 000000000000..1d3f47070f1e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/delete_finetuning_job.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.json new file mode 100644 index 000000000000..9aad97493ea3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.yaml new file mode 100644 index 000000000000..6a311b4afb6f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.json new file mode 100644 index 000000000000..6c97f35bc203 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "$filter": "created_at gt 1646120000 and created_at lt 1646130000 and status eq 'completed'", + "$orderby": "created_at asc" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "first_id": "batch_abc123", + "last_id": "batch_abc456", + "metadata": { + "batch_description": "Evaluation job" + } + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.yaml new file mode 100644 index 000000000000..b93eeb21f080 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_batches.yaml @@ -0,0 +1,39 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + $filter: created_at gt 1646120000 and created_at lt 1646130000 and status eq 'completed' + $orderby: created_at asc +responses: + "200": + headers: {} + body: + has_more: false + data: + - object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + first_id: batch_abc123 + last_id: batch_abc456 + metadata: + batch_description: Evaluation job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.json new file mode 100644 index 000000000000..59f433555fd5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.yaml new file mode 100644 index 000000000000..13856034b641 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.json new file mode 100644 index 000000000000..ed445d477dce --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.yaml new file mode 100644 index 000000000000..c6a8dc5da474 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_file_content.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: raw file content diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.json new file mode 100644 index 000000000000..a551197b901e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.yaml new file mode 100644 index 000000000000..b939997c8dec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_files.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview +responses: + 200: + headers: {} + body: + data: + - metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + - metadata: + bytes: 32423 + purpose: fine-tune-results + filename: results.csv + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.json new file mode 100644 index 000000000000..5aedc9edff5b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "method": { + "type": "supervised" + }, + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.yaml new file mode 100644 index 000000000000..1da1f8558485 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job.yaml @@ -0,0 +1,38 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2025-01-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + method: + type: supervised + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.json new file mode 100644 index 000000000000..9e7fc21c2d21 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fine-tuning-job-id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P", + "created_at": 1646126127, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10", + "step_number": 10, + "metrics": { + "step": 10, + "train_loss": 0.478, + "train_mean_token_accuracy": 0.924, + "valid_loss": 10.112, + "valid_mean_token_accuracy": 0.145, + "full_valid_loss": 0.567, + "full_valid_mean_token_accuracy": 0.944 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_frtXDR2453C4FG67t03MLPs5", + "created_at": 1646126137, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20", + "step_number": 20, + "metrics": { + "step": 20, + "train_loss": 0.355, + "train_mean_token_accuracy": 0.947, + "valid_loss": 11.32, + "valid_mean_token_accuracy": 0.122, + "full_valid_loss": 0.317, + "full_valid_mean_token_accuracy": 0.955 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_agLk6Gio560ORp14gl123fgd", + "created_at": 1646126147, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30", + "step_number": 30, + "metrics": { + "step": 30, + "train_loss": 0.155, + "train_mean_token_accuracy": 0.975, + "valid_loss": 9.31, + "valid_mean_token_accuracy": 0.092, + "full_valid_loss": 0.114, + "full_valid_mean_token_accuracy": 0.963 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.yaml new file mode 100644 index 000000000000..fe84f63e75a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_checkpoints.yaml @@ -0,0 +1,54 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + fine-tuning-job-id: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P + created_at: 1646126127 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10 + stepNumber: 10 + metrics: + step: 10 + train_loss: 0.478 + train_mean_token_accuracy: 0.924 + valid_loss: 10.112 + valid_mean_token_accuracy: 0.145 + full_valid_loss: 0.567 + full_valid_mean_token_accuracy: 0.944 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_frtXDR2453C4FG67t03MLPs5 + created_at: 1646126137 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20 + stepNumber: 20 + metrics: + step: 20 + train_loss: 0.355 + train_mean_token_accuracy: 0.947 + valid_loss: 11.32 + valid_mean_token_accuracy: 0.122 + full_valid_loss: 0.317 + full_valid_mean_token_accuracy: 0.955 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_agLk6Gio560ORp14gl123fgd + created_at: 1646126147 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30 + stepNumber: 30 + metrics: + step: 30 + train_loss: 0.155 + train_mean_token_accuracy: 0.975 + valid_loss: 9.31 + valid_mean_token_accuracy: 0.092 + full_valid_loss: 0.114 + full_valid_mean_token_accuracy: 0.963 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.json new file mode 100644 index 000000000000..2754bf5b28c5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05", + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f", + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-2d47d651d2f3484c8187c88c00078147", + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "type": "message", + "object": "fine_tuning.job.event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.yaml new file mode 100644 index 000000000000..2be7b8d07a2f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_job_events.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftevent-363dcd7cb4c74539bc53293c1dceef05 + created_at: 1646126127 + level: Info + message: Job enqueued. Waiting for jobs ahead to complete. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-8c2a44999790437cb3230e543fa2cf0f + created_at: 1646126169 + level: Info + message: Job started. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-2d47d651d2f3484c8187c88c00078147 + created_at: 1646126192 + level: Info + message: Job succeeded. + type: message + data: + object: fine_tuning.job.event + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.json new file mode 100644 index 000000000000..34a6152f1167 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "method": { + "type": "supervised" + }, + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.yaml new file mode 100644 index 000000000000..677e9273e558 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_finetuning_jobs.yaml @@ -0,0 +1,40 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2025-01-01-preview +responses: + 200: + headers: {} + body: + has_more: false + data: + - hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + method: + type: supervised + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.json new file mode 100644 index 000000000000..530f5672dd5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-01-01-preview", + "job-id": "ingestion-job" + }, + "responses": { + "200": { + "body": { + "kind": "UserCompute", + "jobId": "ingestion-job", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.yaml new file mode 100644 index 000000000000..96e21c576349 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2025-01-01-preview + job-id: ingestion-job +responses: + "200": + body: + kind: UserCompute + jobId: ingestion-job + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.json new file mode 100644 index 000000000000..81f91bfd17b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-01-01-preview", + "job-id": "ingestion-job", + "run-id": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b" + }, + "responses": { + "200": { + "body": { + "jobId": "ingestion-job", + "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b", + "status": "running", + "progress": { + "stageProgress": [ + { + "name": "Preprocessing", + "totalItems": 14, + "processedItems": 0, + "state": "notRunning" + }, + { + "name": "Indexing", + "state": "notRunning" + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.yaml new file mode 100644 index 000000000000..61e4d6c9e72f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_ingestion_job_run.yaml @@ -0,0 +1,18 @@ +parameters: + api-version: 2025-01-01-preview + job-id: ingestion-job + run-id: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b +responses: + "200": + body: + jobId: ingestion-job + runId: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b + status: running + progress: + stageProgress: + - name: Preprocessing + totalItems: 14 + processedItems: 0 + state: notRunning + - name: Indexing + state: notRunning diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.json new file mode 100644 index 000000000000..b9da3a44fce8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "model-id": "curie" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.yaml new file mode 100644 index 000000000000..14f582742e7a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_base.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + model-id: curie +responses: + 200: + headers: {} + body: + status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.json new file mode 100644 index 000000000000..359a7efd0ff0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "model-id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.yaml new file mode 100644 index 000000000000..205886a3c63f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_model_finetune.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + model-id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.json new file mode 100644 index 000000000000..08958933de9e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + }, + { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.yaml new file mode 100644 index 000000000000..a029147d81bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/get_models.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview +responses: + 200: + headers: {} + body: + data: + - status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model + - status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.json new file mode 100644 index 000000000000..4edd4037d04a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fileImport": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.yaml new file mode 100644 index 000000000000..19c9446468ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/import_file.yaml @@ -0,0 +1,47 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + fileImport: + purpose: fine-tune + filename: puppy.jsonl + content_url: &o0 + absolutePath: /trainingdata/puppy.jsonl + absoluteUri: *o0 + localPath: /trainingdata/puppy.jsonl + authority: www.contoso.com + hostNameType: Dns + isDefaultPort: true + isFile: false + isLoopback: false + pathAndQuery: /trainingdata/puppy.jsonl + segments: + - / + - trainingdata/ + - puppy.jsonl + isUnc: false + host: www.contoso.com + port: 443 + query: "" + fragment: "" + scheme: https + originalString: *o0 + dnsSafeHost: www.contoso.com + idnHost: www.contoso.com + isAbsoluteUri: true + userEscaped: false + userInfo: "" + metadata: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + metadata: + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.json new file mode 100644 index 000000000000..f777aba8f6f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-01-01-preview", + "job-id": "ingestion-job" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "ingestion-job", + "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036", + "status": "succeeded" + }, + { + "jobId": "ingestion-job", + "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd", + "status": "failed" + }, + { + "jobId": "ingestion-job", + "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b", + "status": "running" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.yaml new file mode 100644 index 000000000000..5027db898a1d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_job_runs.yaml @@ -0,0 +1,16 @@ +parameters: + api-version: 2025-01-01-preview + job-id: ingestion-job +responses: + "200": + body: + value: + - jobId: ingestion-job + runId: f375b912-331c-4fc5-8e9f-2d7205e3e036 + status: succeeded + - jobId: ingestion-job + runId: 07f2d192-add7-4202-a2e3-858c2577f4fd + status: failed + - jobId: ingestion-job + runId: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b + status: running diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.json new file mode 100644 index 000000000000..782f7dae919b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "usercompute-ingestion-job", + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev" + }, + { + "jobId": "syscompute-ingestion-job", + "kind": "SystemCompute" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.yaml new file mode 100644 index 000000000000..8b8f601fc88b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/list_ingestion_jobs.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2025-01-01-preview +responses: + "200": + body: + value: + - jobId: usercompute-ingestion-job + kind: UserCompute + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + - jobId: syscompute-ingestion-job + kind: SystemCompute diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.json new file mode 100644 index 000000000000..219a49a3893b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "batchCreateRequest": { + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "endpoint": "/chat/completions", + "completion_window": "24h", + "metadata": { + "batch_description": "Evaluation job" + } + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "deployment-enqueued-tokens": 1000, + "deployment-maximum-enqueued-tokens": 5000 + }, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "validating", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": null, + "expires_at": null, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 0, + "completed": 0, + "failed": 0 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.yaml new file mode 100644 index 000000000000..1949fae66c99 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_batch.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + batchCreateRequest: + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + endpoint: /chat/completions + completion_window: 24h + metadata: + batch_description: Evaluation job + content-Type: application/json +responses: + "201": + headers: + deployment-enqueued-tokens: 1000 + deployment-maximum-enqueued-tokens: 5000 + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: validating + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: null + expires_at: null + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 0 + completed: 0 + failed: 0 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.json new file mode 100644 index 000000000000..50070f0fd64f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "fineTuningJob": { + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "method": { + "type": "supervised" + }, + "status": "pending", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.yaml new file mode 100644 index 000000000000..bb4983b8ee55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/post_finetuning_job.yaml @@ -0,0 +1,53 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2025-01-01-preview + fineTuningJob: + hyperparameters: + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + method: + type: supervised + model: curie + trainingFile: file-181a1cbdcdcf4677ada87f63a0928099 + validationFile: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: pending + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.json new file mode 100644 index 000000000000..9f500e6b7086 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2025-01-01-preview", + "job-id": "ingestion-job", + "ingestionJob": { + "kind": "SystemCompute", + "searchServiceConnection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://aykame-dev-search.search.windows.net" + }, + "datasource": { + "kind": "Storage", + "connection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://mystorage.blob.core.windows.net/", + "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage" + }, + "containerName": "container", + "chunking": { + "maxChunkSizeInTokens": 2048 + }, + "embeddings": [ + { + "connection": { + "kind": "RelativeConnection" + }, + "deploymentName": "Ada" + } + ] + }, + "dataRefreshIntervalInHours": 24, + "completionAction": "keepAllAssets" + } + }, + "responses": { + "200": { + "headers": { + "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-01-preview" + }, + "body": { + "kind": "SystemCompute", + "jobId": "ingestion-job", + "searchServiceConnection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://aykame-dev-search.search.windows.net" + }, + "datasource": { + "kind": "Storage", + "connection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://mystorage.blob.core.windows.net/", + "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage" + }, + "containerName": "container", + "chunking": { + "maxChunkSizeInTokens": 2048 + }, + "embeddings": [ + { + "connection": { + "kind": "RelativeConnection" + }, + "deploymentName": "Ada" + } + ] + }, + "dataRefreshIntervalInHours": 24, + "completionAction": "keepAllAssets" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.yaml new file mode 100644 index 000000000000..d38c923baafd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_sc.yaml @@ -0,0 +1,51 @@ +parameters: + api-version: 2025-01-01-preview + job-id: ingestion-job + ingestionJob: + kind: SystemCompute + searchServiceConnection: + kind: EndpointWithManagedIdentity + endpoint: "https://aykame-dev-search.search.windows.net" + datasource: + kind: Storage + connection: + kind: EndpointWithManagedIdentity + endpoint: "https://mystorage.blob.core.windows.net/" + resourceId: >- + /subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage + containerName: container + chunking: + maxChunkSizeInTokens: 2048 + embeddings: + - connection: + kind: RelativeConnection + deploymentName: Ada + dataRefreshIntervalInHours: 24 + completionAction: keepAllAssets +responses: + "200": + headers: + operation-location: >- + https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-01-preview + body: + kind: SystemCompute + jobId: ingestion-job + searchServiceConnection: + kind: EndpointWithManagedIdentity + endpoint: "https://aykame-dev-search.search.windows.net" + datasource: + kind: Storage + connection: + kind: EndpointWithManagedIdentity + endpoint: "https://mystorage.blob.core.windows.net/" + resourceId: >- + /subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage + containerName: container + chunking: + maxChunkSizeInTokens: 2048 + embeddings: + - connection: + kind: RelativeConnection + deploymentName: Ada + dataRefreshIntervalInHours: 24 + completionAction: keepAllAssets diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.json new file mode 100644 index 000000000000..bf2b2055b66c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-01-01-preview", + "job-id": "ingestion-job", + "ingestionJob": { + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": { + "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-01-preview" + }, + "body": { + "kind": "UserCompute", + "jobId": "ingestion-job", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.yaml new file mode 100644 index 000000000000..1c0744ddac9e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/put_ingestion_job_uc.yaml @@ -0,0 +1,39 @@ +parameters: + api-version: 2025-01-01-preview + job-id: ingestion-job + ingestionJob: + kind: UserCompute + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder +responses: + "200": + headers: + operation-location: >- + https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-01-01-preview + body: + kind: UserCompute + jobId: ingestion-job + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.json new file mode 100644 index 000000000000..68e3374caa39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "purpose": "fine-tune", + "content-Type": "multipart/form-data", + "file": "raw file content" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.yaml new file mode 100644 index 000000000000..e9285c299648 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file.yaml @@ -0,0 +1,19 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + purpose: fine-tune + Content-Type: multipart/form-data + file: raw file content +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + metadata: + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.json new file mode 100644 index 000000000000..887d390294f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "cancelled", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.yaml new file mode 100644 index 000000000000..bd047d688930 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_cancel.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: cancelled + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.json new file mode 100644 index 000000000000..e3a81ddc697c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "body": { + "part_ids": [ + "LnmictL3p0u4LH/ko343nw==", + "LmmictL3p0u4LH/ko343nw==" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "completed", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.yaml new file mode 100644 index 000000000000..0300504d785a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_complete.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + part_ids: + - LnmictL3p0u4LH/ko343nw== + - LmmictL3p0u4LH/ko343nw== + md5: +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: completed + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.json new file mode 100644 index 000000000000..d536d15e71d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "data": "raw file content", + "content-Type": "multipart/form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "azure_block_id": "LnmictL3p0u4LH/ko343nw==", + "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload.part" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.yaml new file mode 100644 index 000000000000..29e9e570dd7e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_part.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + data: raw file content + Content-Type: multipart/form-data +responses: + 200: + headers: {} + body: + upload_id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + azure_block_id: LnmictL3p0u4LH/ko343nw== + id: uplprt-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload.part diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.json new file mode 100644 index 000000000000..ef78db94c53e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2025-01-01-preview", + "body": { + "purpose": "fine-tune", + "filename": "training_data_v21.jsonl", + "bytes": 2097152, + "mime_type": "application/json" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "pending", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.yaml new file mode 100644 index 000000000000..6f62c806c119 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2025-01-01-preview/examples/upload_file_start.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2025-01-01-preview + body: + purpose: fine-tune + filename: training_data_v21.jsonl + bytes: 2097152 + mimeType: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: pending + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index b263be62f7f9..c283ca6e044e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md @@ -451,3 +451,23 @@ directive: - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + +## AzureOpenAI 2025-01-01-preview +These settings apply only when `--tag=release_2025_01_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025_01_01_preview' +input-file: preview/2025-01-01-preview/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.json new file mode 100644 index 000000000000..6d4c45162b39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.json @@ -0,0 +1,18 @@ +{ + "title": "Synthesizes audio from the provided text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "input": "Hi! What are you going to make?", + "voice": "fable", + "response_format": "mp3" + } + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.yaml new file mode 100644 index 000000000000..28acb96409a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_speech.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2025-01-01-preview + body: + input: Hi! What are you going to make? + response_format: mp3 + voice: fable + deployment-id: + endpoint: "{endpoint}" +responses: + "200": + body: "101010101" +title: Synthesizes audio from the provided text. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.json new file mode 100644 index 000000000000..907a84f47e1e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.yaml new file mode 100644 index 000000000000..7d6991f71545 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_object.yaml @@ -0,0 +1,9 @@ +parameters: + api-version: 2025-01-01-preview + deployment-id: + endpoint: "{endpoint}" +responses: + "200": + body: + text: A structured object when requesting json or verbose_json +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.json new file mode 100644 index 000000000000..aa496f8df193 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.yaml new file mode 100644 index 000000000000..9460b4f83467 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_transcription_text.yaml @@ -0,0 +1,19 @@ +parameters: + api-version: 2025-01-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: "{endpoint}" +responses: + "200": + example: plain text when requesting text, srt, or vtt + type: string +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.json new file mode 100644 index 000000000000..f7ecae037317 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.json @@ -0,0 +1,16 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.yaml new file mode 100644 index 000000000000..35bccc1addcc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_object.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2025-01-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: "{endpoint}" +responses: + "200": + body: + text: A structured object when requesting json or verbose_json +title: + Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.json new file mode 100644 index 000000000000..054731eb82c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.yaml new file mode 100644 index 000000000000..f47e9f372e28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/audio_translation_text.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2025-01-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: + endpoint: "{endpoint}" +responses: + "200": + example: plain text when requesting text, srt, or vtt + type: string +title: + Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.json new file mode 100644 index 000000000000..a28aab5256a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.json @@ -0,0 +1,46 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [ + "vs_123" + ] + } + }, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.yaml new file mode 100644 index 000000000000..d7e452ddf2ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_run.yaml @@ -0,0 +1,35 @@ +title: | + Cancels a run that is `in_progress`. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699076126 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: cancelling + started_at: 1699076126 + expires_at: 1699076726 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-turbo + instructions: You summarize books. + tools: + - type: file_search + tool_resources: + file_search: + vector_store_ids: + - vs_123 + metadata: {} + usage: null + temperature: 1 + top_p: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..bc59d5a2cc97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.yaml new file mode 100644 index 000000000000..22bc64d7a614 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/cancel_vector_store_file_batch.yaml @@ -0,0 +1,20 @@ +title: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: cancelling + file_counts: + in_progress: 12 + completed: 3 + failed: 0 + cancelled: 0 + total: 15 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.json new file mode 100644 index 000000000000..1f58a215c30b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.json @@ -0,0 +1,43 @@ +{ + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.yaml new file mode 100644 index 000000000000..60fca87554eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions.yaml @@ -0,0 +1,45 @@ +title: Creates a completion for the provided prompt, parameters and chosen model. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: system + content: you are a helpful assistant that talks like a pirate + - role: user + content: can you tell me how to care for a parrot? +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: |- + Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy: + + 1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr! + + 2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh! + + 3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands! + + 4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh! + + 5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr! + + 6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag! + + 7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be. + + 8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners. + + So there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' "Yo-ho-ho" for many years to come! Good luck, sailor, and may the wind be at yer back! + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..41012fab6721 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.json @@ -0,0 +1,96 @@ +{ + "title": "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a cat?" + }, + { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "intent": "cat care" + } + }, + { + "role": "user", + "content": "how about dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content 2.", + "title": "Citation Title 2", + "filepath": "contoso2.txt", + "url": "https://contoso.blob.windows.net/container/contoso2.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.yaml new file mode 100644 index 000000000000..f72e754a9299 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_advanced.yaml @@ -0,0 +1,63 @@ +title: Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a cat? + - role: assistant + content: Content of the completion [doc1]. + context: + intent: cat care + - role: user + content: how about dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + authentication: + type: user_assigned_managed_identity + managed_identity_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name} + index_name: "{index name}" + query_type: vector + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + in_scope: true + top_n_documents: 5 + strictness: 3 + role_information: You are an AI assistant that helps people find information. + fields_mapping: + content_fields_separator: \n + content_fields: + - content + filepath_field: filepath + title_field: title + url_field: url + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content 2. + title: Citation Title 2 + filepath: contoso2.txt + url: https://contoso.blob.windows.net/container/contoso2.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..bce42878583d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.json @@ -0,0 +1,58 @@ +{ + "title": "Creates a completion based on Azure Search image vector data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + }, + "authentication": { + "type": "api_key", + "key": "{api key}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion." + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.yaml new file mode 100644 index 000000000000..2fe7bcb03479 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_image_vector.yaml @@ -0,0 +1,36 @@ +title: Creates a completion based on Azure Search image vector data. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: "{index name}" + query_type: vector + fields_mapping: + image_vector_fields: + - image_vector + authentication: + type: api_key + key: "{api key}" +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion. + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..900dab2210ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.json @@ -0,0 +1,63 @@ +{ + "title": "Creates a completion based on Azure Search data and system-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "authentication": { + "type": "system_assigned_managed_identity" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.yaml new file mode 100644 index 000000000000..500f2eb850aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_azure_search_minimum.yaml @@ -0,0 +1,39 @@ +title: Creates a completion based on Azure Search data and system-assigned managed identity. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: "{index name}" + authentication: + type: system_assigned_managed_identity +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.json new file mode 100644 index 000000000000..b665cd26fe8c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Azure Cosmos DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.yaml new file mode 100644 index 000000000000..025fa4857763 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_cosmos_db.yaml @@ -0,0 +1,49 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_cosmos_db + parameters: + authentication: + type: connection_string + connection_string: mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000 + database_name: vectordb + container_name: azuredocs + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.json new file mode 100644 index 000000000000..803c3febcdd3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.json @@ -0,0 +1,65 @@ +{ + "title": "Creates a completion for the provided Elasticsearch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.yaml new file mode 100644 index 000000000000..473f9b463c04 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_elasticsearch.yaml @@ -0,0 +1,41 @@ +title: Creates a completion for the provided Elasticsearch. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: elasticsearch + parameters: + endpoint: https://your-elasticsearch-endpoint.eastus.azurecontainer.io + index_name: "{index name}" + authentication: + type: key_and_key_id + key: "{key}" + key_id: "{key id}" +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.json new file mode 100644 index 000000000000..5aaffbee0f33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.json @@ -0,0 +1,80 @@ +{ + "title": "Creates a completion for the provided Mongo DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "mongo_db", + "parameters": { + "authentication": { + "type": "username_and_password", + "username": "", + "password": "" + }, + "endpoint": "", + "app_name": "", + "database_name": "sampledb", + "collection_name": "samplecollection", + "index_name": "sampleindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.yaml new file mode 100644 index 000000000000..ecd5771b9c9b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_mongo_db.yaml @@ -0,0 +1,52 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: mongo_db + parameters: + authentication: + type: username_and_password + username: + password: + endpoint: + app_name: + database_name: sampledb + collection_name: samplecollection + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.json new file mode 100644 index 000000000000..8a5cdd5342c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Pinecone resource.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.yaml new file mode 100644 index 000000000000..a1c62429d572 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/chat_completions_pinecone.yaml @@ -0,0 +1,51 @@ +title: Creates a completion for the provided Pinecone resource. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: pinecone + parameters: + authentication: + type: api_key + key: "{api key}" + environment: "{environment name}" + index_name: "{index name}" + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + title_field: title + url_field: url + filepath_field: filepath + content_fields: + - content + content_fields_separator: |+ + +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/completions.json new file mode 100644 index 000000000000..d65f3facccc3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.json new file mode 100644 index 000000000000..c7cd41fc790b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.json @@ -0,0 +1,39 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.yaml new file mode 100644 index 000000000000..3056ac890402 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_assistant.yaml @@ -0,0 +1,26 @@ +title: Create an assistant with a model and instructions. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + body: + name: Math Tutor + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + model: gpt-4-1106-preview +responses: + "200": + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant + created_at: 1707295707 + name: Math Tutor + description: null + model: gpt-4-1106-preview + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.json new file mode 100644 index 000000000000..6c7cba9683b6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.json @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.yaml new file mode 100644 index 000000000000..eab3618e23c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_message.yaml @@ -0,0 +1,25 @@ +title: Create a message. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + role: user + content: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. +responses: + "200": + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + assistant_id: null + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + run_id: null + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + attachments: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.json new file mode 100644 index 000000000000..fcbc1071298d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.json @@ -0,0 +1,49 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.yaml new file mode 100644 index 000000000000..f8ec08cd3450 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_run.yaml @@ -0,0 +1,38 @@ +title: Create a run. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + body: + assistant_id: asst_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699063290 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: queued + started_at: 1699063290 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699063291 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + metadata: {} + usage: null + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.json new file mode 100644 index 000000000000..1ff1cf41e0e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.yaml new file mode 100644 index 000000000000..0a75df6ec99a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread.yaml @@ -0,0 +1,11 @@ +title: Creates a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..afa293a3e1dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.yaml new file mode 100644 index 000000000000..51aace91579b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_thread_and_run.yaml @@ -0,0 +1,42 @@ +title: Create a thread and run it in one request. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + body: + assistant_id: asst_abc123 + thread: + messages: + - role: user + content: Explain deep learning to a 5 year old. +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699076792 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: queued + started_at: null + expires_at: 1699077392 + cancelled_at: null + failed_at: null + completed_at: null + required_action: null + last_error: null + model: gpt-4-turbo + instructions: You are a helpful assistant. + tools: [] + tool_resources: {} + metadata: {} + temperature: 1 + top_p: 1 + max_completion_tokens: null + max_prompt_tokens: null + truncation_strategy: + type: auto + last_messages: null + incomplete_details: null + usage: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.json new file mode 100644 index 000000000000..8328f2042db1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.json @@ -0,0 +1,28 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview" + }, + "body": { + "name": "Support FAQ" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.yaml new file mode 100644 index 000000000000..f1d63efcb18c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store.yaml @@ -0,0 +1,20 @@ +title: Creates a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview +body: + name: Support FAQ +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 + name: Support FAQ + bytes: 139920 + file_counts: + in_progress: 0 + completed: 3 + failed: 0 + cancelled: 0 + total: 3 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.json new file mode 100644 index 000000000000..9e0b2fcd47c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.json @@ -0,0 +1,24 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.yaml new file mode 100644 index 000000000000..f0a6e232067e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file.yaml @@ -0,0 +1,17 @@ +title: Create a vector store file by attaching a File to a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + body: + file_id: file-abc123 +responses: + "200": + body: + id: file-abc123 + object: vector_store.file + created_at: 1699061776 + usage_bytes: 1234 + vector_store_id: vs_abcd + status: completed + last_error: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.json new file mode 100644 index 000000000000..b45c7d6073d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.json @@ -0,0 +1,30 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.yaml new file mode 100644 index 000000000000..856e72d9fb5b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/create_vector_store_file_batch.yaml @@ -0,0 +1,22 @@ +title: Create a vector store file batch. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + body: + file_ids: + - file-abc123 + - file-abc456 +responses: + "200": + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: in_progress + file_counts: + in_progress: 1 + completed: 1 + failed: 0 + cancelled: 0 + total: 0 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..5687cfe6f532 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.yaml new file mode 100644 index 000000000000..0ed9f391332d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant.yaml @@ -0,0 +1,11 @@ +title: Deletes an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + assistant_id: asst_4nsG2qgNzimRPE7MazXTXbU7 +responses: + "200": + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.json new file mode 100644 index 000000000000..a54a2bb26b02 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.yaml new file mode 100644 index 000000000000..6e85f6c11177 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_assistant_file.yaml @@ -0,0 +1,12 @@ +title: Deletes an AssistantFile. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + "200": + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.json new file mode 100644 index 000000000000..73f3d3c300b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.yaml new file mode 100644 index 000000000000..99219d1dadd1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_message.yaml @@ -0,0 +1,12 @@ +title: Deletes a message. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.json new file mode 100644 index 000000000000..a4053914f109 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.yaml new file mode 100644 index 000000000000..e0d868775b5b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_thread.yaml @@ -0,0 +1,11 @@ +title: Deletes a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.json new file mode 100644 index 000000000000..df5d42bb0f7f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.yaml new file mode 100644 index 000000000000..9b0b8f63c903 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store.yaml @@ -0,0 +1,11 @@ +title: Deletes a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: "vs_abc123 " +responses: + "200": + body: + id: vs_abc123 + object: vector_store.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.json new file mode 100644 index 000000000000..8c3925eca198 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.yaml new file mode 100644 index 000000000000..b507e73b237b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/delete_vector_store_file.yaml @@ -0,0 +1,12 @@ +title: Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + file_id: file_abc123 +responses: + "200": + body: + id: file_abc123 + object: vector_store.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.json new file mode 100644 index 000000000000..a4f9296e457a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.json @@ -0,0 +1,1566 @@ +{ + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.yaml new file mode 100644 index 000000000000..ce4eb56ab7eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/embeddings.yaml @@ -0,0 +1,1553 @@ +title: Return the embeddings for a given prompt. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + deployment-id: deployment-afa0669ca01e4693ae3a93baf40f26d6 + body: + input: + - this is a test +responses: + "200": + body: + data: + - index: 0 + embedding: + - -0.012838088 + - -0.007421397 + - -0.017617522 + - -0.028278312 + - -0.018666342 + - 0.01737855 + - -0.01821495 + - -0.006950092 + - -0.009937238 + - -0.038580645 + - 0.010674067 + - 0.02412286 + - -0.013647936 + - 0.013189907 + - 0.0021125758 + - 0.012406612 + - 0.020790534 + - 0.00074595667 + - 0.008397198 + - -0.00535031 + - 0.008968075 + - 0.014351576 + - -0.014086051 + - 0.015055214 + - -0.022211088 + - -0.025198232 + - 0.0065186154 + - -0.036350243 + - 0.009180495 + - -0.009698266 + - 0.009446018 + - -0.008463579 + - -0.0040426035 + - -0.03443847 + - -0.00091273896 + - -0.0019217303 + - 0.002349888 + - -0.021560553 + - 0.016515596 + - -0.015572986 + - 0.0038666942 + - -8.432463e-05 + - 0.0032178196 + - -0.020365695 + - -0.009631885 + - -0.007647093 + - 0.0033837722 + - -0.026764825 + - -0.010501476 + - 0.020219658 + - 0.024640633 + - -0.0066912062 + - -0.036456455 + - -0.0040923897 + - -0.013966565 + - 0.017816665 + - 0.005366905 + - 0.022835068 + - 0.0103488 + - -0.0010811808 + - -0.028942121 + - 0.0074280356 + - -0.017033368 + - 0.0074877786 + - 0.021640211 + - 0.002499245 + - 0.013316032 + - 0.0021524043 + - 0.010129742 + - 0.0054731146 + - 0.03143805 + - 0.014856071 + - 0.0023366117 + - -0.0008243692 + - 0.022781964 + - 0.003038591 + - -0.017617522 + - 0.0013309394 + - 0.0022154662 + - 0.00097414135 + - 0.012041516 + - -0.027906578 + - -0.023817508 + - 0.013302756 + - -0.003003741 + - -0.006890349 + - 0.0016744611 + - 0.023658194 + - -0.015851786 + - -0.0045305043 + - -0.003038591 + - 0.017710455 + - 0.019237218 + - 0.016037652 + - -0.022503164 + - 0.025795663 + - -0.001129307 + - 0.032500144 + - -0.008178141 + - -0.019940857 + - -0.009877495 + - 0.00018918588 + - 0.023060765 + - -0.005692172 + - -0.018347712 + - -0.011039163 + - -0.0062066247 + - -5.24047e-05 + - 0.020126723 + - -0.0011691356 + - -0.015811957 + - 0.020086896 + - -0.009114114 + - -0.03056182 + - 0.0029025099 + - -0.006591635 + - -0.014046223 + - -0.01590489 + - -0.02307404 + - -0.008861865 + - -0.004832538 + - 0.010030171 + - 0.02311387 + - -0.012652221 + - 0.024906157 + - 0.003860056 + - -0.01936998 + - -0.02957938 + - -0.008357369 + - -0.0016371218 + - 0.027800368 + - 0.0077333883 + - 0.021626934 + - 0.02140124 + - -0.030482162 + - 0.026406368 + - -0.008277712 + - 0.012884554 + - -0.043784916 + - -0.0145639945 + - -0.0070297495 + - 0.034889862 + - -0.00041508878 + - -0.010528029 + - -0.009572142 + - 0.015692472 + - 0.037810627 + - -0.0022021902 + - 0.008662722 + - -0.016794397 + - 0.0003090866 + - -0.0060506295 + - 0.015227805 + - 0.0006650548 + - 0.01842737 + - 0.036801632 + - -0.002461076 + - -0.0029390194 + - -0.0057120863 + - -0.012486269 + - -0.0046831807 + - -0.0017474802 + - -0.0036210844 + - -0.01178263 + - 0.017869769 + - 0.039111692 + - 0.010946229 + - 0.018467197 + - 0.0027780454 + - -0.005851486 + - -0.016489044 + - 0.03186289 + - -0.040333103 + - 0.016648358 + - -0.006870435 + - 0.0072687212 + - 2.370982e-06 + - 0.006465511 + - -0.018201673 + - -0.00020526254 + - -0.025410652 + - 0.02010017 + - 0.017537864 + - 0.022821793 + - 0.0064555537 + - -0.0012969191 + - 0.02157383 + - -0.0053536287 + - -0.0087622935 + - -0.010952868 + - 0.017564416 + - 0.02185263 + - 0.0004733796 + - 0.0018337755 + - -0.6954606 + - -0.011231667 + - 0.02748174 + - 0.003929756 + - 0.0144843375 + - 0.045192193 + - 0.01898497 + - -0.0070363875 + - -0.007813046 + - 0.017604245 + - -0.017790113 + - 0.011165286 + - -0.0036376796 + - -0.014736585 + - 0.0016421003 + - -0.019144284 + - -0.0072222543 + - -0.023127146 + - 0.006936816 + - 0.025198232 + - 0.0030219958 + - 0.011722887 + - -0.004271618 + - -0.0011127117 + - -0.0051047 + - 0.00077333883 + - 0.018599961 + - 0.0074877786 + - 0.010820106 + - 0.0033406245 + - -0.015055214 + - 0.02384406 + - 0.006090458 + - 0.00891497 + - 0.023366116 + - -0.011078991 + - -0.019582398 + - 0.0011566891 + - 0.015413672 + - 0.01793615 + - -0.014736585 + - 0.002492607 + - 0.027800368 + - 0.023923717 + - -0.007421397 + - 0.0016105693 + - 0.011337877 + - -0.015041938 + - -0.008768932 + - -0.003982861 + - 0.002884255 + - -0.007832959 + - 0.0025457118 + - -0.0023548664 + - -0.0061767534 + - -0.016754568 + - 0.0006036523 + - 0.0105346665 + - 0.0055361767 + - 0.01478969 + - -0.0011251582 + - 0.009605332 + - -0.0037140178 + - -0.017537864 + - -0.021733144 + - 0.012897831 + - -0.024481317 + - 0.022290744 + - 0.0056523434 + - -0.005366905 + - 0.0020412162 + - 0.013435517 + - -0.003408665 + - -0.01705992 + - 0.029446619 + - 0.022011945 + - 0.009226961 + - -0.003310753 + - -0.007939169 + - 0.021308305 + - 0.0026718357 + - 0.002129171 + - -0.020047067 + - -0.007474502 + - 0.021534001 + - -0.0110590765 + - -0.018374264 + - -0.001664504 + - -0.003923118 + - 0.015387119 + - 0.025516862 + - 0.0016421003 + - -0.017498035 + - -0.01825478 + - 0.01451089 + - -0.008198055 + - -0.011656506 + - 0.0044242945 + - 0.031491153 + - 0.01017621 + - -0.010408543 + - -0.009034456 + - -0.0023283141 + - 0.012021601 + - 0.015639367 + - 0.011736163 + - 0.007912617 + - 0.02031259 + - 0.022104878 + - -0.02241023 + - 0.00041156227 + - -0.009817752 + - -0.030880447 + - -0.0017823302 + - 0.0030933553 + - -0.04128899 + - -0.0007783174 + - 0.012393335 + - 0.0122273825 + - -0.009087561 + - 0.022728859 + - -0.002884255 + - 0.028065892 + - 0.0047396044 + - 0.008065294 + - 0.015519881 + - 0.0133956885 + - -0.02279524 + - -0.011729525 + - 0.0037206558 + - -0.0046732235 + - 0.003587894 + - 0.024401661 + - -0.013574918 + - 0.012685412 + - -0.0041620894 + - 0.020578114 + - 0.007394845 + - 0.014139156 + - -0.012512821 + - -0.021042781 + - 0.022423506 + - -0.015360567 + - 0.004009413 + - 0.0104550095 + - -0.024799947 + - -0.0081449505 + - -0.00063850236 + - 0.0070231115 + - -0.0009633545 + - -0.015705748 + - -0.0028942123 + - -0.008815398 + - 0.007461226 + - -0.014417957 + - -0.012931022 + - 0.0015674217 + - -0.02506547 + - -0.0063128346 + - -0.013422241 + - -0.0058614435 + - -0.0006007482 + - -0.015002109 + - 0.0037040606 + - -0.008410474 + - -0.0016089098 + - -0.018653065 + - 0.020538285 + - -0.016980262 + - -0.042244878 + - -0.017498035 + - 0.006727716 + - -0.01877255 + - 0.008987989 + - 0.00077665783 + - -0.0007119364 + - -0.0067243967 + - 0.0038467797 + - -0.018055636 + - -0.01440468 + - 0.007534245 + - 0.0051212953 + - 0.002741536 + - 0.011523744 + - -0.0018603279 + - 0.023684746 + - 0.016196968 + - 0.01731217 + - -0.01992758 + - 0.009372999 + - -0.01982137 + - 0.001150051 + - -0.014417957 + - 0.005672258 + - -0.015785405 + - 0.0049387473 + - -0.0051445286 + - 0.012632307 + - 0.0011666464 + - 0.024587527 + - 0.04259006 + - -0.0025672857 + - 0.02311387 + - -0.014524166 + - 0.0013848739 + - -0.04105002 + - -0.010089914 + - -0.009087561 + - 0.015440224 + - 0.009207047 + - 0.0128048975 + - -0.030216638 + - -0.02549031 + - 0.00499849 + - 0.02737553 + - 0.024985814 + - -0.015055214 + - 0.007580712 + - -0.003979542 + - 0.0016304837 + - 0.0010446712 + - 0.0033373055 + - 0.0066314633 + - -0.011948583 + - -0.021281753 + - 0.012161002 + - 0.030747686 + - 0.03555367 + - 0.023751127 + - -0.03159736 + - -0.0110590765 + - 0.015758853 + - -0.0012197511 + - -0.0023249951 + - -0.0007488608 + - 0.0074877786 + - 0.01643594 + - -0.008098484 + - 0.03730613 + - -0.0010056724 + - -3.4798173e-05 + - 0.011702972 + - 0.039563086 + - -0.012280487 + - 0.027747264 + - 0.018387541 + - 0.033057746 + - -0.004835857 + - -0.00471969 + - 0.025450481 + - -0.0051146573 + - 0.014603823 + - 0.00022258384 + - 0.00060863094 + - 0.015665919 + - -0.021626934 + - -0.013674489 + - 0.0062066247 + - 0.018560132 + - 0.031942543 + - 0.012054792 + - 0.004902238 + - 0.0028510645 + - -0.027667606 + - 0.009817752 + - -0.002580562 + - 0.0069036256 + - 0.020047067 + - -0.009704905 + - -0.012619031 + - -0.0056755766 + - -0.0036443176 + - 0.019383255 + - 0.0030701219 + - 0.024972538 + - 0.009100837 + - 0.026353262 + - 0.012758431 + - 0.029074885 + - 0.021202097 + - -0.0038102702 + - -0.032048754 + - 0.003996137 + - 0.0029738694 + - 0.0032277768 + - -0.026127568 + - -0.02213143 + - 0.0028742978 + - 0.0010637557 + - 0.000580419 + - 0.0021789568 + - 0.00083764544 + - 0.026924139 + - -0.03265946 + - 0.0059211864 + - 0.021892458 + - 0.01178263 + - 0.0018188398 + - 0.009718181 + - -0.020047067 + - 0.017989255 + - 0.0046035233 + - -0.010561219 + - -0.010342162 + - 0.009505761 + - -0.018334435 + - -0.00667793 + - -0.024534423 + - 0.00035347888 + - 0.00082561385 + - -0.006143563 + - 0.016820949 + - -0.0013500239 + - -0.0069832825 + - 0.015347291 + - -0.005094743 + - 0.001838754 + - 0.017073197 + - 0.02521151 + - 0.006209944 + - -0.015612815 + - -0.009744733 + - -0.019794818 + - 0.007786493 + - 0.037624758 + - 0.017564416 + - 0.0076802834 + - 0.0026203906 + - 0.0022403593 + - -0.024560975 + - -0.04062518 + - -0.016581977 + - 0.00789934 + - 0.0099305995 + - 0.006996559 + - 0.011078991 + - 0.016236795 + - -0.0068969876 + - 0.01374087 + - 0.014922452 + - -0.0042882133 + - 0.00022901449 + - -0.0006692036 + - 0.001359981 + - -7.581957e-05 + - 0.0042616613 + - 0.0066381013 + - 0.012512821 + - 0.021534001 + - 0.0032775626 + - 0.016913882 + - -0.00789934 + - -0.009200408 + - -0.020286039 + - -0.017033368 + - 0.014378128 + - 0.009233599 + - 0.0070828544 + - -0.013229736 + - 0.025928425 + - -0.011862287 + - 0.008383922 + - 0.012632307 + - -0.0003097089 + - 0.007593988 + - 0.0059079104 + - -0.0026369859 + - -0.0262205 + - 0.003335646 + - -0.0067609064 + - -0.0042882133 + - 0.008549875 + - -0.007600626 + - -0.012592479 + - 0.028623493 + - -0.0030502076 + - -0.006989921 + - -0.015785405 + - 0.010050085 + - 0.016714739 + - -0.023724575 + - -0.006346025 + - -0.014245366 + - -0.032154962 + - -0.03388087 + - -0.024308728 + - -0.002461076 + - -0.003733932 + - -0.02195884 + - -0.021069333 + - -0.022144707 + - -0.007872788 + - -0.017179407 + - -0.009034456 + - -0.010893124 + - -0.02478667 + - -0.020153277 + - -0.023976821 + - 0.014656927 + - 0.0005368565 + - -0.015878338 + - 0.010123105 + - -0.0030717815 + - 0.01555971 + - 0.0018321159 + - -0.036244035 + - 0.00017176087 + - -0.013375774 + - -0.010375353 + - 0.026512576 + - 0.016581977 + - 0.013847079 + - 0.015719024 + - 0.013223098 + - 0.004975257 + - -0.0010579474 + - -0.0034385365 + - -0.029048331 + - 0.017298892 + - -0.022529716 + - 0.008463579 + - -0.014723309 + - -0.005814977 + - -0.009027818 + - -0.009738095 + - -0.0104682855 + - -0.005044957 + - 0.007905979 + - 0.011656506 + - 0.003153098 + - -0.0005231654 + - 0.019954132 + - -0.021985391 + - -0.005307162 + - 0.0021839354 + - -0.025184957 + - 0.013926737 + - -0.0059908866 + - 0.0065717204 + - 0.009884133 + - -0.0062298584 + - 0.03388087 + - 0.0028577026 + - -0.015931444 + - 0.0010986058 + - -0.025808938 + - 0.0022835068 + - 0.014152432 + - 0.015227805 + - 0.013701041 + - -0.007872788 + - -0.030614924 + - -0.026393091 + - 0.0010753724 + - -0.016940435 + - 0.013647936 + - -0.007408121 + - -0.024308728 + - -0.031915992 + - -0.018161846 + - 0.00072521257 + - 0.028862465 + - 0.012234021 + - -0.019555846 + - -0.027641054 + - -0.00082810316 + - -0.0019150922 + - -0.016276624 + - -0.01125822 + - -0.034146395 + - -0.015294186 + - 0.006671292 + - -0.015533158 + - 0.013674489 + - -0.0011766035 + - -0.017325444 + - -0.023233354 + - -0.013189907 + - 0.0005580154 + - -0.03188944 + - -0.007056302 + - -0.0059942054 + - 0.03411984 + - 0.04317421 + - 0.029420065 + - 0.006488744 + - -0.0022436783 + - 0.013063784 + - 0.00012207884 + - 0.008118398 + - -0.023246631 + - 0.0051909955 + - -0.00894816 + - 0.0081316745 + - 0.0023200165 + - 0.011510468 + - -0.0005770999 + - 0.00016979019 + - 0.010129742 + - 0.015506605 + - -0.0073815687 + - 0.0031995648 + - -0.026578957 + - -0.016674912 + - 0.0049652997 + - 0.0072687212 + - -0.016568702 + - -0.001964878 + - -0.015692472 + - -0.0048955996 + - 0.027773816 + - 0.012864641 + - 0.01594472 + - 0.008244522 + - 0.017139578 + - -0.01772373 + - -0.0012521119 + - 0.011689696 + - 0.0111121815 + - -0.0036476366 + - 0.0012570905 + - -0.007826322 + - -0.016754568 + - 0.011948583 + - -0.0045968853 + - 0.023963546 + - -0.0052739717 + - 0.014656927 + - 0.009731457 + - 0.010727172 + - -0.01705992 + - -0.0026071144 + - 0.010760362 + - 0.000919377 + - -0.006365939 + - -0.03013698 + - -0.010554581 + - -0.018613236 + - 0.013886908 + - 0.029420065 + - -0.013030593 + - 0.016860778 + - -0.019237218 + - -0.022118153 + - 0.007919255 + - -0.0004003605 + - 0.046546366 + - 0.01349526 + - 0.006352663 + - 0.014258642 + - 0.0031813101 + - -0.027017072 + - 0.0070828544 + - -0.020219658 + - 0.0037140178 + - 0.023366116 + - 0.040386207 + - -0.016382834 + - -0.0023681426 + - 0.0064522345 + - 0.016528873 + - 0.0006804054 + - -0.02891557 + - -0.0043545947 + - 0.01101261 + - -0.0014778073 + - -0.018055636 + - -0.0077001974 + - -0.0358723 + - 0.003373815 + - -0.00071940426 + - -0.011822458 + - -0.024295451 + - -0.009791199 + - -0.026565682 + - 0.020989677 + - -0.035155386 + - 0.01832116 + - 0.014776413 + - -0.028012788 + - -0.007262083 + - 0.0030402504 + - -0.029446619 + - 0.00010174965 + - 0.009758009 + - 0.03767786 + - -0.0154535 + - 0.009346447 + - 0.016077481 + - 0.0041189417 + - -0.027800368 + - 0.01720596 + - -0.011158649 + - 0.027800368 + - -0.03003077 + - -0.0072819972 + - 0.0014296811 + - 0.0145374425 + - 0.0043280423 + - -0.017086472 + - -0.01611731 + - -0.01258584 + - -0.016927158 + - 0.007607264 + - 0.018825656 + - 0.011331239 + - -0.0057784673 + - 0.001569911 + - -0.013900184 + - -0.014776413 + - -0.0050814664 + - -0.0012454737 + - -0.0115967635 + - -0.017458206 + - -0.013203184 + - -0.0063692583 + - -0.01244644 + - 0.011882202 + - 0.0007708495 + - -0.02035242 + - 0.016250072 + - 0.018414093 + - -0.029526275 + - 0.012751793 + - -0.01555971 + - 0.0013840442 + - -0.019502742 + - 0.0063758963 + - 0.0037538463 + - -0.035686433 + - 0.027534844 + - -0.016409386 + - -0.03247359 + - -0.008782208 + - -0.0059842486 + - 0.014338299 + - 0.009233599 + - -0.0053171194 + - 0.006160158 + - 0.0072952732 + - 0.01401967 + - 0.008815398 + - -0.023790956 + - 0.013096974 + - -0.0031365028 + - 0.005044957 + - 0.0005356118 + - -0.009379637 + - 0.0066248253 + - -0.00010724682 + - 0.010289057 + - 0.008815398 + - -0.02279524 + - -0.019701885 + - -0.0027747264 + - 0.016183691 + - -0.014205537 + - -0.003933075 + - -0.013375774 + - -0.005751915 + - -0.010116466 + - 0.004988533 + - -0.005904591 + - -0.008656085 + - -0.017431654 + - -0.011988411 + - -0.01594472 + - 0.00660823 + - -0.027216217 + - 0.0073218257 + - -0.029977666 + - -0.004593566 + - -0.026671892 + - -0.028517283 + - -0.0050084474 + - 0.009844304 + - 0.025729282 + - -0.013780698 + - -0.026751548 + - 0.004905557 + - -0.035951957 + - -0.026738273 + - -0.019768266 + - 0.0048690476 + - 0.005250738 + - 0.0014603822 + - -0.018892037 + - 0.017683903 + - 0.0067177587 + - 0.027694158 + - -0.002618731 + - -0.012419888 + - 0.01772373 + - -0.0032593077 + - 0.006611549 + - 0.016648358 + - -0.03789028 + - -0.023100592 + - 0.023684746 + - 0.0031248862 + - 0.016382834 + - 0.019967409 + - -0.008941523 + - -0.02014 + - 0.0073882067 + - 0.011357792 + - -0.0031796505 + - -0.0030253148 + - -0.0010206081 + - -0.017577693 + - -0.009598695 + - 0.002915786 + - 0.001325131 + - -0.0029207645 + - -0.010780277 + - -0.00325101 + - -0.00811176 + - -0.00073434 + - -0.030083876 + - -0.012864641 + - -0.012745155 + - -0.011769353 + - 0.018785827 + - -0.008264436 + - -0.002675155 + - 0.024255622 + - 0.005483072 + - -0.018480474 + - -0.005426648 + - 0.015095043 + - 0.00044392303 + - 0.011271496 + - -0.0027548121 + - 0.0026884312 + - -0.00894816 + - -0.015161424 + - -0.014975557 + - -0.024600804 + - 0.004457485 + - -0.015519881 + - -0.012366783 + - -0.012579202 + - 0.01478969 + - 0.0075541595 + - -0.017962702 + - -0.0017441611 + - -0.014059499 + - 0.005499667 + - -0.0026884312 + - 0.0031929268 + - 0.0010853296 + - -0.008045379 + - 0.017471483 + - 0.02590187 + - -0.018546855 + - -0.007826322 + - 0.009333171 + - 0.0157323 + - 8.6036016e-05 + - 0.004776114 + - 0.22155327 + - 0.006787459 + - -0.0017823302 + - 0.024919434 + - 0.0023449094 + - 0.03210186 + - 0.0047329664 + - -0.010879848 + - 0.0044342517 + - 0.015334014 + - 0.029499723 + - 0.019715162 + - -0.008569789 + - -0.0018901994 + - -0.0077400263 + - -0.019210665 + - -0.005088105 + - -0.023153698 + - -0.032739118 + - -0.029313855 + - 0.00082146504 + - -0.0212552 + - 0.0044309325 + - -0.005446562 + - 0.018613236 + - -0.009751371 + - -0.013023955 + - -0.001996409 + - 0.01915756 + - 0.017431654 + - -0.031092867 + - -0.0070231115 + - 0.025330994 + - -0.00018099198 + - -0.025131851 + - -0.011025886 + - 0.0116498675 + - -0.02506547 + - 0.029234199 + - -0.012287126 + - 0.0069766445 + - 0.0018752636 + - 0.014271918 + - 0.005108019 + - -0.0109064 + - 0.014391404 + - 0.0062597296 + - -0.031411495 + - 0.00014935728 + - 0.013236375 + - -0.02891557 + - -0.0006671292 + - 0.008662722 + - 0.012161002 + - 0.020963125 + - -0.0133691365 + - 0.02653913 + - -0.017989255 + - 0.007978998 + - 0.0093398085 + - -0.02024621 + - 0.03265946 + - -0.02846418 + - 0.025397375 + - -0.024693737 + - -0.0027050264 + - -0.019330151 + - -0.0104417335 + - 0.015626092 + - -0.006541849 + - 0.004653309 + - -0.025118576 + - 0.0038268655 + - 0.004045923 + - -0.017564416 + - -0.02444149 + - 0.030296294 + - 0.028756255 + - 0.03927101 + - 0.010767001 + - -0.012034878 + - -0.007122683 + - -0.022476612 + - -0.034942966 + - -0.028411074 + - -0.03927101 + - -0.0037505273 + - -0.0038799702 + - -0.00037111135 + - -0.009718181 + - -0.013455432 + - -0.015400395 + - -0.0066978442 + - -0.010760362 + - 0.015121595 + - 0.03111942 + - 0.007992274 + - 0.0270569 + - -0.003104972 + - 0.010056724 + - -0.018414093 + - 0.006472149 + - 0.021281753 + - 0.0043579135 + - -0.00021490853 + - 0.0008546556 + - -0.01269205 + - -0.003936394 + - 0.0008870163 + - 0.0009816092 + - 0.0054664765 + - -0.031278733 + - 0.017245788 + - 0.00027734818 + - 0.005161124 + - 0.0048093046 + - -0.003923118 + - -0.027149836 + - 0.006950092 + - -0.00615352 + - 0.014205537 + - 0.0016620146 + - 0.0047396044 + - 0.0039994563 + - -0.015440224 + - -0.0055627287 + - -0.026273604 + - 0.0013276202 + - 0.0021009592 + - -0.034810204 + - 0.0064522345 + - 0.00042608313 + - 0.02307404 + - -0.005957696 + - 0.0016869075 + - -0.0032775626 + - -0.009041094 + - -0.01227385 + - -0.04349284 + - 0.015652644 + - 0.013468708 + - -0.0023249951 + - -0.011171925 + - 0.0030352718 + - -0.0061203293 + - -0.023153698 + - 0.046068422 + - -0.005582643 + - -0.02405648 + - 0.005433286 + - -0.02814555 + - -0.0036874653 + - 0.0067841397 + - 0.006628144 + - 0.029844904 + - -0.0044276137 + - -0.029127989 + - -0.04548427 + - 0.022091601 + - 0.0038069512 + - -0.030269742 + - 0.0051578046 + - 0.043572497 + - -0.0144843375 + - -0.02891557 + - -0.010461648 + - -0.17375894 + - 0.029154541 + - 0.019648781 + - -0.00038335036 + - 0.0029572742 + - -0.0026469429 + - 0.035925403 + - -0.012021601 + - 0.0015566348 + - -0.0033124126 + - 0.0010430117 + - -0.010620962 + - -0.022582822 + - 0.00601412 + - 0.008364008 + - -0.0016586956 + - -0.0011102224 + - -0.013860356 + - 0.022542993 + - 0.020564837 + - 0.018414093 + - -0.008908332 + - 0.032951534 + - -0.011908754 + - 0.010169571 + - -0.011198477 + - 0.0029108075 + - 0.033084296 + - 0.0029008503 + - -0.0010015236 + - -0.019794818 + - 0.005844848 + - 0.011669782 + - 0.0052208668 + - 0.010129742 + - 0.0037737607 + - 0.02880936 + - -0.018599961 + - -0.015095043 + - 0.026578957 + - 0.019662056 + - 0.006823968 + - -0.00045885876 + - -0.019396532 + - -0.0047993474 + - 0.017192682 + - 0.039589636 + - -0.00874238 + - 0.02146762 + - -0.007667007 + - 0.018785827 + - -0.012758431 + - -0.010010257 + - -0.02052501 + - 0.016090758 + - 0.0061867107 + - -0.0145507185 + - 0.008065294 + - 0.0104284575 + - -0.0022386997 + - -0.008324179 + - -0.021640211 + - 0.01705992 + - -0.010541305 + - -0.01639611 + - -0.0074413116 + - -0.034703992 + - 0.007016473 + - -0.003083398 + - 0.0013691084 + - -0.005108019 + - -0.007886064 + - 0.00053270767 + - -0.018865485 + - 0.025503585 + - 0.005101381 + - -0.027534844 + - 0.015028661 + - -0.009286704 + - 0.006233177 + - 4.343289e-05 + - 0.036031615 + - 0.00957878 + - 0.019250493 + - 0.0024411618 + - 0.0023664832 + - -0.0030269742 + - -0.007939169 + - 0.0058581247 + - 0.00587472 + - 0.036589216 + - -0.035288148 + - -0.012997403 + - -0.0110989055 + - -0.002492607 + - 0.008151589 + - -0.008085207 + - -0.00734174 + - -0.0016802694 + - 0.008403837 + - -0.007793131 + - -0.003913161 + - -0.025437204 + - 0.027123282 + - 0.019330151 + - -0.008729103 + - 0.003943032 + - 0.010289057 + - 0.029977666 + - 0.0014836156 + - -0.024282174 + - -0.0024361832 + - 0.0110325245 + - 0.021719867 + - 0.012844726 + - 0.015002109 + - 0.020737428 + - -0.013037231 + - 0.014802966 + - -0.0027332383 + - 0.041634172 + - -0.00926679 + - -0.018759275 + - 0.018666342 + - 0.005386819 + - -0.008822037 + - -0.068399 + - -0.054804165 + - 0.027800368 + - 0.04954679 + - -0.00437119 + - 0.029127989 + - 0.03180978 + - 0.021321582 + - -0.022503164 + - 0.010554581 + - -0.006823968 + - -0.021387963 + - -0.021865906 + - -0.0074479496 + - 0.0037206558 + - 0.004132218 + - 0.01073381 + - -0.0021673401 + - -0.0012819833 + - 0.041235887 + - -0.010202762 + - 0.004839176 + - 0.0081715025 + - -0.030402504 + - -0.023764404 + - -0.010800191 + - -0.018374264 + - 0.033641897 + - 0.005416691 + - -0.0055096243 + - -0.0032775626 + - -0.018095464 + - 0.008563151 + - -0.02339267 + - -0.013674489 + - 0.0023382711 + - -0.028411074 + - -0.0024063117 + - 0.026658615 + - -0.012413249 + - 0.009333171 + - 0.026446195 + - -0.009107475 + - -0.024560975 + - 0.0011085629 + - -0.02395027 + - 0.0013857037 + - 0.01926377 + - -0.0020710877 + - -0.031278733 + - -0.015095043 + - 0.0041720467 + - -0.012798259 + - 0.010162933 + - 0.0063128346 + - -0.010972782 + - 0.045617033 + - 0.016874054 + - -0.010368714 + - -0.0055992384 + - -0.0092999805 + - 0.0015782086 + - -0.013581555 + - 0.017843217 + - -0.01615714 + - 0.0036575939 + - -0.027110007 + - -0.013621384 + - 0.022197811 + - 0.0013964906 + - -0.007348378 + - 0.0145772705 + - -0.003996137 + - 0.0008364008 + - -0.03411984 + - 0.013030593 + - -0.021454344 + - -0.05034336 + - 0.021095887 + - -0.0055029863 + - -0.025623072 + - -0.023525432 + - 0.007335102 + - -0.043413185 + - 0.016316453 + - 0.016196968 + - 0.0093132565 + - -0.0110989055 + - 0.0154535 + - -0.045218747 + - 0.0037737607 + - 0.01639611 + - 0.019887751 + - -0.023366116 + - -0.024043202 + - 0.014258642 + - 0.004271618 + - -0.006877073 + - 0.021387963 + - -0.0019781543 + - -0.036350243 + - -0.009114114 + - -0.037359234 + - 0.01919739 + - 0.011829097 + - -0.015665919 + - -0.0015591241 + - 0.0144843375 + - -0.003139822 + - -0.024083031 + - -0.015307462 + - -0.0040990277 + - -0.013223098 + - 0.0024278855 + - -0.008702551 + - -0.0033207103 + - -0.009804476 + - -0.010554581 + - 0.031066315 + - 0.0044408897 + - 0.025370823 + - 0.009406189 + - 0.025583243 + - -0.002066109 + - 0.015267633 + - 0.008337456 + - -0.009426104 + - 0.01590489 + - -0.011716249 + - 0.007713474 + - -0.029552827 + - -0.013900184 + - 0.0050150855 + - -0.01650232 + - -0.0015757193 + - 0.008549875 + - -0.020471904 + - 0.008397198 + - -0.013136802 + - 0.021520725 + - 0.0060406723 + - 0.012858002 + - -0.004723009 + - -0.029313855 + - 0.009240237 + - -0.0212552 + - -0.028118998 + - 0.017803388 + - -0.0314646 + - 0.012353507 + - 0.029632485 + - -1.6128512e-05 + - 0.016966987 + - 0.009711542 + - -0.037253026 + - -0.015095043 + - 0.013442155 + - -0.00905437 + - -0.000982439 + - -0.0020495139 + - 0.008337456 + - -0.020644495 + - 0.042085562 + - -0.000744712 + - 0.021135716 + - -0.0072886352 + - 0.01643594 + - 0.013767422 + - -0.0044707614 + - -0.014763137 + - 0.018852208 + - -0.03080079 + - -0.0049188333 + - 0.0058846767 + - 0.008330817 + - 0.008257798 + - 0.024202518 + - 0.02307404 + - 0.011065715 + - 0.00036053188 + - -0.00049412367 + - 0.036270585 + - 0.027043626 + - 0.011902116 + - -0.027773816 + - 0.013289479 + - 0.018374264 + - -0.0033157317 + - 0.0016636741 + - 0.0020677685 + - -0.012293763 + - 0.008184779 + - -0.034252603 + - 0.010753725 + - 0.008675998 + - 0.00968499 + - -0.003793675 + - -0.011218391 + - 0.010375353 + - -0.0005737809 + - 0.019781543 + - 0.020591391 + - 0.019954132 + - -0.00053976063 + - -0.0059444197 + - -0.022675755 + - -0.010003619 + - 0.0038467797 + - -0.0212552 + - -0.033482585 + - -0.015572986 + - 0.0037737607 + - 0.01451089 + - 0.0036376796 + - 0.007454588 + - 0.013979842 + - -0.013402327 + - 0.014975557 + - -0.010435095 + - 0.0151747 + - -0.030375952 + - 0.023166973 + - -0.0024760119 + - -0.005881358 + - 0.019914305 + - -0.008596341 + - 0.017737007 + - -0.0036111271 + - 0.012499545 + - -0.02647275 + - 0.0053901384 + - 0.008556513 + - 0.019648781 + - 0.00874238 + - -0.012439802 + - -0.028623493 + - -0.022330573 + - -0.0029340407 + - -0.016303178 + - 0.007474502 + - -0.016555425 + - 0.060645696 + - 0.0023631642 + - -0.012054792 + - 0.017604245 + - 0.013103612 + - 0.026061187 + - 0.015533158 + - 0.025742557 + - 0.00013753316 + - -0.013940013 + - 0.02880936 + - 0.010109829 + - -0.0036111271 + - -0.012419888 + - -0.045457717 + - 0.022835068 + - -0.014139156 + - 0.007819683 + - -0.010461648 + - -0.012008325 + - 0.008895056 + - 0.015984548 + - 0.024043202 + - -0.00059825886 + - -0.0036376796 + - -0.007939169 + - 0.0242689 + - -0.022197811 + - -0.026313433 + - -0.026724996 + - 0.010939592 + - 0.0023449094 + - -0.012074706 + - -0.018493751 + - 0.017697178 + - -0.0052142288 + - -0.00360117 + - 0.0056058764 + - 0.01070062 + - 0.0035248317 + - 0.023671469 + - 0.030880447 + - -0.020299314 + - -0.0145905465 + - 0.018055636 + - -0.013727593 + - -0.023313012 + - 0.013236375 + - -0.0020113448 + usage: + prompt_tokens: 4 + total_tokens: 4 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_speech.json new file mode 100644 index 000000000000..99fba50f1d61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_speech.json @@ -0,0 +1,19 @@ +{ + "operationId": "GenerateSpeechFromText", + "title": "Generates text-to-speech audio from the input text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "input": "The text to generate audio for", + "voice": "alloy" + } + }, + "responses": { + "200": { + "content-type": "application/octet-stream", + "body": "RIFF...audio.data.omitted" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_object.json new file mode 100644 index 000000000000..a68e37e70391 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranscriptionAsResponseObject", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_text.json new file mode 100644 index 000000000000..77c691f480e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_transcription_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranscriptionAsPlainText", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_object.json new file mode 100644 index 000000000000..d20b4113d492 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranslationAsResponseObject", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_text.json new file mode 100644 index 000000000000..9ad82fd650e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_audio_translation_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranslationAsPlainText", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_chat_completions.json new file mode 100644 index 000000000000..50c973309e39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_chat_completions.json @@ -0,0 +1,45 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_completions.json new file mode 100644 index 000000000000..fb7a4e5c1780 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_embeddings.json new file mode 100644 index 000000000000..ed9252c2cb5d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..5bdba4598e19 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_aml_index.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_ml_index", + "parameters": { + "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}", + "name": "gm-cars", + "version": "5" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..2cda1040df88 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json @@ -0,0 +1,86 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..7634aaa2e921 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json @@ -0,0 +1,67 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..6c39e27aae41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json @@ -0,0 +1,61 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..7f425c653418 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..51a339398481 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json @@ -0,0 +1,66 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..4964e1221cf3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_extensions_chat_completions_pinecone.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_image_generation.json new file mode 100644 index 000000000000..085c20cc8e4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deploymentId": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + }, + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_01.png?se=2023-10-27T17%3A45%3A09Z&...", + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.json new file mode 100644 index 000000000000..1e9044f7b59c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.yaml new file mode 100644 index 000000000000..68c73c518e79 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_assistant_file.yaml @@ -0,0 +1,13 @@ +title: Retrieves an AssistantFile. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + "200": + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.json new file mode 100644 index 000000000000..3b07597d944e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.yaml new file mode 100644 index 000000000000..4c9dc0be5903 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message.yaml @@ -0,0 +1,23 @@ +title: Retrieve a message. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + message_id: msg_as3XIk1tpVP3hdHjWBGg3uG4 +responses: + "200": + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + file_ids: [] + assistant_id: null + run_id: null + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.json new file mode 100644 index 000000000000..c623e9adb476 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.json @@ -0,0 +1,20 @@ +{ + "title": "Retrieves a message file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.yaml new file mode 100644 index 000000000000..521af10c40f1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_message_file.yaml @@ -0,0 +1,14 @@ +title: Retrieves a message file. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 + file_id: file_abc123 +responses: + "200": + body: + id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.json new file mode 100644 index 000000000000..3a3410f40266 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.json @@ -0,0 +1,32 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.yaml new file mode 100644 index 000000000000..d52d2ccf929b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run.yaml @@ -0,0 +1,26 @@ +title: Gets a run. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q +responses: + "200": + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1707303196 + assistant_id: asst_JtTwHk28cIocgFXZPCBxhOzl + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: completed + started_at: 1707303197 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1707303201 + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.json new file mode 100644 index 000000000000..15d615ecba99 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.yaml new file mode 100644 index 000000000000..74dc35f15377 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/get_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + step_id: step_abc123 +responses: + "200": + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.json new file mode 100644 index 000000000000..db4ce69e662b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.json @@ -0,0 +1,71 @@ +{ + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "deployment-id": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.", + "prompt_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + }, + "profanity": { + "detected": false, + "filtered": false + }, + "custom_blocklists": { + "filtered": false, + "details": [] + } + }, + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...", + "content_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.yaml new file mode 100644 index 000000000000..d5e46890fc43 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/image_generation.yaml @@ -0,0 +1,49 @@ +title: "Creates images given a prompt." +parameters: + endpoint: "{endpoint}" + api-version: "2025-01-01-preview" + deployment-id: "" + body: + prompt: "In the style of WordArt, Microsoft Clippy wearing a cowboy hat." + n: 1 + style: "natural" + quality: "standard" +responses: + "200": + body: + created: 1698342300 + data: + - revised_prompt: "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + prompt_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false + profanity: + detected: false + filtered: false + custom_blocklists: + filtered: false + details: [] + url: "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + content_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.json new file mode 100644 index 000000000000..d89c636bbbca --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.json @@ -0,0 +1,26 @@ +{ + "title": "Returns a list of assistant files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + ], + "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.yaml new file mode 100644 index 000000000000..b2426612a48b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistant_files.yaml @@ -0,0 +1,17 @@ +title: Returns a list of assistant files. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA +responses: + "200": + body: + object: list + data: + - id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + first_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + last_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.json new file mode 100644 index 000000000000..506b313708bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.json @@ -0,0 +1,70 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.yaml new file mode 100644 index 000000000000..2ea45a553c14 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_assistants.yaml @@ -0,0 +1,54 @@ +title: Returns a list of assistants. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + order: desc + limit: 20 +responses: + "200": + body: + object: list + data: + - id: asst_abc123 + object: assistant + created_at: 1707257477 + name: Stock Analyst + description: null + model: gpt-4-1106-preview + instructions: You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs. + tools: + - type: code_interpreter + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + - id: asst_abc456 + object: assistant + created_at: 1698982718 + name: My Assistant + description: null + model: gpt-4-turbo + instructions: You are a helpful assistant designed to make me better at coding! + tools: [] + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + - id: asst_abc789 + object: assistant + created_at: 1698982643 + name: null + description: null + model: gpt-4-turbo + instructions: null + tools: [] + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + first_id: asst_abc123 + last_id: asst_abc789 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.json new file mode 100644 index 000000000000..4ad8e4ecaeea --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of message files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + }, + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc123", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.yaml new file mode 100644 index 000000000000..f72fff0a8b58 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_message_files.yaml @@ -0,0 +1,22 @@ +title: Returns a list of message files. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + first_id: file-abc123 + last_id: file-abc123 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.json new file mode 100644 index 000000000000..c7a0b03fc68d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.json @@ -0,0 +1,60 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.yaml new file mode 100644 index 000000000000..3a7c952705e7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_messages.yaml @@ -0,0 +1,41 @@ +title: List Messages +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 +responses: + "200": + body: + object: list + data: + - id: msg_abc123 + object: thread.message + created_at: 1699016383 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + attachments: [] + metadata: {} + - id: msg_abc456 + object: thread.message + created_at: 1699016383 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: Hello, what is AI? + annotations: [] + attachments: [] + metadata: {} + first_id: msg_abc123 + last_id: msg_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..0ba38e8b2dc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.yaml new file mode 100644 index 000000000000..fb8f624eca48 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_run_steps.yaml @@ -0,0 +1,35 @@ +title: Returns a list of run steps belonging to a run. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + object: list + data: + - id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + first_id: step_abc123 + last_id: step_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.json new file mode 100644 index 000000000000..9cbc1ec18834 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.json @@ -0,0 +1,112 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.yaml new file mode 100644 index 000000000000..3042dbc07bae --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_runs.yaml @@ -0,0 +1,85 @@ +title: Returns a list of runs belonging to a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 +responses: + "200": + body: + object: list + data: + - id: run_abc123 + object: thread.run + created_at: 1699075072 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699075072 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699075073 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + tool_resources: + code_interpreter: + file_ids: + - file-abc123 + - file-abc456 + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto + - id: run_abc456 + object: thread.run + created_at: 1699063290 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699063290 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699063291 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + tool_resources: + code_interpreter: + file_ids: + - file-abc123 + - file-abc456 + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto + first_id: run_abc123 + last_id: run_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.json new file mode 100644 index 000000000000..a60bb4f2fc5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of vector store files in a batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.yaml new file mode 100644 index 000000000000..b47ca09e5b47 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_file_batch.yaml @@ -0,0 +1,22 @@ +title: Returns a list of vector store files in a batch. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + - id: file-abc456 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + first_id: file-abc123 + last_id: file-abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.json new file mode 100644 index 000000000000..c690b4b9fe42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.json @@ -0,0 +1,32 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.yaml new file mode 100644 index 000000000000..2b0b7986b584 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_store_files.yaml @@ -0,0 +1,21 @@ +title: Returns a list of vector store files. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + - id: file-abc456 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + first_id: file-abc123 + last_id: file-abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.json new file mode 100644 index 000000000000..4918122c7521 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.yaml new file mode 100644 index 000000000000..a27e3f0d01d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/list_vector_stores.yaml @@ -0,0 +1,51 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": + { "endpoint": "{endpoint}", "api-version": "2025-01-01-preview" }, + "responses": + { + "200": + { + "body": + { + "object": "list", + "data": + [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": + { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3, + }, + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": + { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3, + }, + }, + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false, + }, + }, + }, +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.json new file mode 100644 index 000000000000..36a0a804aea3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.json @@ -0,0 +1,44 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "assistant_id": "asst_abc123", + "body": { + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.yaml new file mode 100644 index 000000000000..4e41fc078bcb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_assistant.yaml @@ -0,0 +1,29 @@ +title: Modifies an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + assistant_id: asst_abc123 + body: + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files. + tools: + - type: file_search + model: gpt-4-turbo +responses: + "200": + body: + id: asst_123 + object: assistant + created_at: 1699009709 + name: HR Helper + description: null + model: gpt-4-turbo + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files. + tools: + - type: file_search + tool_resources: + file_search: + vector_store_ids: [] + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.json new file mode 100644 index 000000000000..e7be3d6d5528 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "file_ids": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.yaml new file mode 100644 index 000000000000..f5dafee205e5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_message.yaml @@ -0,0 +1,29 @@ +title: Modify a message. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + message_id: "msg_abc123 " + body: + metadata: + modified: "true" + user: abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message + created_at: 1699017614 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + file_ids: [] + metadata: + modified: "true" + user: abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.json new file mode 100644 index 000000000000..72a6a98df8f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.json @@ -0,0 +1,66 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.yaml new file mode 100644 index 000000000000..556245de018f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_run.yaml @@ -0,0 +1,55 @@ +{ + "title": "Modifies a run.", + "parameters": + { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { "metadata": { "user_id": "user_abc123" } }, + }, + "responses": + { + "200": + { + "body": + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [{ "type": "code_interpreter" }], + "tool_resources": + { + "code_interpreter": + { "file_ids": ["file-abc123", "file-abc456"] }, + }, + "metadata": { "user_id": "user_abc123" }, + "usage": + { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579, + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { "type": "auto", "last_messages": null }, + "response_format": "auto", + "tool_choice": "auto", + }, + }, + }, +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.json new file mode 100644 index 000000000000..0bd277f58ddf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.yaml new file mode 100644 index 000000000000..2fef0341433f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_thread.yaml @@ -0,0 +1,19 @@ +title: Modifies a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + metadata: + modified: "true" + user: abc123 +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: + modified: "true" + user: abc123 + tool_resources: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.json new file mode 100644 index 000000000000..ca2ee473d52a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.yaml new file mode 100644 index 000000000000..033f7531ffec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/modify_vector_store.yaml @@ -0,0 +1,21 @@ +title: Modifies a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + body: + name: Support FAQ +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 + name: Support FAQ + bytes: 139920 + file_counts: + in_progress: 0 + completed: 3 + failed: 0 + cancelled: 0 + total: 3 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.json new file mode 100644 index 000000000000..d46e02fdb62c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "assistant_id": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "tools": [ + { + "type": "file_search" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.yaml new file mode 100644 index 000000000000..c01566ba1a3e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_assistant.yaml @@ -0,0 +1,21 @@ +title: Retrieves an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + assistant_id: asst_abc123 +responses: + "200": + body: + id: asst_abc123 + object: assistant + created_at: 1699009709 + name: HR Helper + description: null + model: gpt-4-turbo + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. + tools: + - type: file_search + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.json new file mode 100644 index 000000000000..d8f371cf4929 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieves a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.yaml new file mode 100644 index 000000000000..012b32b9f245 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_message.yaml @@ -0,0 +1,23 @@ +title: Retrieves a message. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message + created_at: 1699017614 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + attachments: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.json new file mode 100644 index 000000000000..08f5afe660a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.json @@ -0,0 +1,51 @@ +{ + "title": "Retrieves a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.yaml new file mode 100644 index 000000000000..c3494275477a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run.yaml @@ -0,0 +1,40 @@ +title: Retrieves a run. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699075072 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699075072 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699075073 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.json new file mode 100644 index 000000000000..d17c9f68029c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.yaml new file mode 100644 index 000000000000..1374f0a704c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_abc123 + run_id: run_abc123 + step_id: step_abc123 +responses: + "200": + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.json new file mode 100644 index 000000000000..0f151c8788ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.yaml new file mode 100644 index 000000000000..c0a8ea301b49 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_thread.yaml @@ -0,0 +1,15 @@ +title: Retrieves a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} + tool_resources: + code_interpreter: + file_ids: [] diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.json new file mode 100644 index 000000000000..e590ac2eadb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.yaml new file mode 100644 index 000000000000..27d20b4861be --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store.yaml @@ -0,0 +1,11 @@ +title: Retrieves a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.json new file mode 100644 index 000000000000..9aefe289256f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.json @@ -0,0 +1,21 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.yaml new file mode 100644 index 000000000000..c13e0a34f025 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file.yaml @@ -0,0 +1,15 @@ +title: Retrieves a vector store file. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + file_id: file-abc123 +responses: + "200": + body: + id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abcd + status: completed + last_error: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.json new file mode 100644 index 000000000000..4475446e3770 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.yaml new file mode 100644 index 000000000000..c66982714bf4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/retrieve_vector_store_file_batch.yaml @@ -0,0 +1,20 @@ +title: Retrieves a vector store file batch. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: in_progress + file_counts: + in_progress: 1 + completed: 1 + failed: 0 + cancelled: 0 + total: 0 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..9f77416674bb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,77 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2025-01-01-preview", + "thread_id": "thread_123", + "run_id": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.yaml new file mode 100644 index 000000000000..756702a41515 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/examples/submit_tool_outputs_to_run.yaml @@ -0,0 +1,57 @@ +title: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. +parameters: + endpoint: "{endpoint}" + api-version: 2025-01-01-preview + thread_id: thread_123 + run_id: run_123 + body: + tool_outputs: + - tool_call_id: call_001 + output: 70 degrees and sunny. +responses: + "200": + body: + id: run_123 + object: thread.run + created_at: 1699075592 + assistant_id: asst_123 + thread_id: thread_123 + status: queued + started_at: 1699075592 + expires_at: 1699076192 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-turbo + instructions: null + tools: + - type: function + function: + name: get_current_weather + description: Get the current weather in a given location + parameters: + type: object + properties: + location: + type: string + description: The city and state, e.g. San Francisco, CA + unit: + type: string + enum: + - celsius + - fahrenheit + required: + - location + metadata: {} + usage: null + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.json new file mode 100644 index 000000000000..46f5afdc4d69 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.json @@ -0,0 +1,12518 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2025-01-01-preview" + }, + "servers": [ + { + "url": "https://{endpoint}/openai", + "variables": { + "endpoint": { + "default": "your-resource-name.openai.azure.com" + } + } + } + ], + "security": [ + { + "bearer": [ + "api.read" + ] + }, + { + "apiKey": [] + } + ], + "paths": { + "/deployments/{deployment-id}/completions": { + "post": { + "summary": "Creates a completion for the provided prompt, parameters and chosen model.", + "operationId": "Completions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "davinci", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionRequest" + }, + "example": { + "prompt": "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:", + "max_tokens": 50 + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionResponse" + }, + "example": { + "model": "davinci", + "object": "text_completion", + "id": "cmpl-4509KAos68kxOqpE2uYGw81j6m7uo", + "created": 1637097562, + "choices": [ + { + "index": 0, + "text": "The price for bubblegum decreased on thursday.", + "logprobs": null, + "finish_reason": "stop" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a completion.": { + "$ref": "./examples/completions.json" + } + } + } + }, + "/deployments/{deployment-id}/embeddings": { + "post": { + "summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.", + "operationId": "embeddings_create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "ada-search-index-v1" + }, + "description": "The deployment id of the model which was deployed." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true, + "properties": { + "input": { + "description": "Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for `text-embedding-ada-002`), cannot be an empty string, and any array must be 2048 dimensions or less.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 2048, + "items": { + "type": "string", + "minLength": 1, + "example": "This is a test.", + "nullable": false + } + } + ] + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse.", + "type": "string", + "nullable": false + }, + "input_type": { + "description": "input type of embedding search to use", + "type": "string", + "example": "query" + }, + "encoding_format": { + "description": "The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`.", + "type": "string", + "example": "float", + "nullable": true + }, + "dimensions": { + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.", + "type": "integer", + "example": 1, + "nullable": true + } + }, + "required": [ + "input" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "object": { + "type": "string" + }, + "model": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "object": { + "type": "string" + }, + "embedding": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "index", + "object", + "embedding" + ] + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "model", + "data", + "usage" + ] + } + } + } + } + }, + "x-ms-examples": { + "Create a embeddings.": { + "$ref": "./examples/embeddings.json" + } + } + } + }, + "/deployments/{deployment-id}/chat/completions": { + "post": { + "summary": "Creates a completion for the chat message", + "operationId": "ChatCompletions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/createChatCompletionResponse" + }, + { + "$ref": "#/components/schemas/createChatCompletionStreamResponse" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a chat completion.": { + "$ref": "./examples/chat_completions.json" + }, + "Creates a completion based on Azure Search data and system-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Search image vector data.": { + "$ref": "./examples/chat_completions_azure_search_image_vector.json" + }, + "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided Azure Cosmos DB.": { + "$ref": "./examples/chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Mongo DB.": { + "$ref": "./examples/chat_completions_mongo_db.json" + }, + "Creates a completion for the provided Elasticsearch.": { + "$ref": "./examples/chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource.": { + "$ref": "./examples/chat_completions_pinecone.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/transcriptions": { + "post": { + "summary": "Transcribes audio into the input language.", + "operationId": "Transcriptions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio transcription with json response format.": { + "$ref": "./examples/audio_transcription_object.json" + }, + "Create an audio transcription with text response format.": { + "$ref": "./examples/audio_transcription_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/translations": { + "post": { + "summary": "Transcribes and translates input audio into English text.", + "operationId": "Translations_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranslationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio translation with json response format.": { + "$ref": "./examples/audio_translation_object.json" + }, + "Create an audio translation with text response format.": { + "$ref": "./examples/audio_translation_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/speech": { + "post": { + "summary": "Generates audio from the input text.", + "operationId": "Speech_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "tts-1", + "description": "Deployment id of the tts model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createSpeechRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + }, + "x-ms-examples": { + "Create an audio from text with response format mp3.": { + "$ref": "./examples/audio_speech.json" + } + } + } + }, + "/deployments/{deployment-id}/images/generations": { + "post": { + "summary": "Generates a batch of images from a text caption on a given DALLE model deployment", + "operationId": "ImageGenerations_Create", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/imageGenerationsRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "dalle-deployment", + "description": "Deployment id of the dalle model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generateImagesResponse" + } + } + } + }, + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dalleErrorResponse" + } + } + } + } + }, + "x-ms-examples": { + "Create an image.": { + "$ref": "./examples/image_generation.json" + } + } + } + }, + "/assistants": { + "get": { + "operationId": "List_Assistants", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of assistants.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListAssistantsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listAssistantsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all assistants.": { + "$ref": "./examples/list_assistants.json" + } + } + }, + "post": { + "operationId": "Create_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Create an assistant with a model and instructions.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Create an assistant.": { + "$ref": "./examples/create_assistant.json" + } + } + } + }, + "/assistants/{assistant_id}": { + "get": { + "operationId": "Get_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Retrieves an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/retrieve_assistant.json" + } + } + }, + "post": { + "operationId": "Modify_Assistant", + "tags": [ + "Assistant" + ], + "summary": "Modifies an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/modify_assistant.json" + } + } + }, + "delete": { + "operationId": "Delete_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Delete an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteAssistantResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete an assistant.": { + "$ref": "./examples/delete_assistant.json" + } + } + } + }, + "/threads": { + "post": { + "operationId": "Create_Thread", + "tags": [ + "Assistants" + ], + "summary": "Create a thread.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread.": { + "$ref": "./examples/create_thread.json" + } + } + } + }, + "/threads/{thread_id}": { + "get": { + "operationId": "Get_Thread", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a thread.": { + "$ref": "./examples/retrieve_thread.json" + } + } + }, + "post": { + "operationId": "Modify_Thread", + "tags": [ + "Assistants" + ], + "summary": "Modifies a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to modify. Only the `metadata` can be modified." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a thread.": { + "$ref": "./examples/modify_thread.json" + } + } + }, + "delete": { + "operationId": "Delete_Thread", + "tags": [ + "Assistants" + ], + "summary": "Delete a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteThreadResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a thread.": { + "$ref": "./examples/delete_thread.json" + } + } + } + }, + "/threads/{thread_id}/messages": { + "get": { + "operationId": "List_Messages", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of messages for a given thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) the messages belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListMessagesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "in": "query", + "description": "Filter messages by the run ID that generated them.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listMessagesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all messages.": { + "$ref": "./examples/list_messages.json" + } + } + }, + "post": { + "operationId": "Create_Message", + "tags": [ + "Assistants" + ], + "summary": "Create a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to create a message for." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } + } + } + }, + "/threads/{thread_id}/messages/{message_id}": { + "get": { + "operationId": "Get_Message", + "tags": [ + "Assistants" + ], + "summary": "Retrieve a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } + } + }, + "post": { + "operationId": "Modify_Message", + "tags": [ + "Assistants" + ], + "summary": "Modifies a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/modify_message.json" + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "Create_Thread_And_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a thread and run it in one request.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadAndRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread and run it.": { + "$ref": "./examples/create_thread_and_run.json" + } + } + } + }, + "/threads/{thread_id}/runs": { + "get": { + "operationId": "List_Runs", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of runs belonging to a thread.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run belongs to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all runs.": { + "$ref": "./examples/list_runs.json" + } + } + }, + "post": { + "operationId": "Create_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to run." + }, + { + "name": "include[]", + "in": "query", + "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "step_details.tool_calls[*].file_search.results[*].content" + ], + "x-ms-enum": { + "name": "Include", + "modelAsString": true, + "values": [ + { + "value": "step_details.tool_calls[*].file_search.results[*].content" + } + ] + } + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}": { + "get": { + "operationId": "Get_Run", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run.": { + "$ref": "./examples/get_run.json" + } + } + }, + "post": { + "operationId": "Modify_Run", + "tags": [ + "Assistants" + ], + "summary": "Modifies a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a run.": { + "$ref": "./examples/modify_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/submit_tool_outputs": { + "post": { + "operationId": "Submit_Tool_Outputs_To_Run", + "tags": [ + "Assistants" + ], + "summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run that requires the tool output submission." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/submitToolOutputsRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Submit tool outputs to a run.": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/cancel": { + "post": { + "operationId": "Cancel_Run", + "tags": [ + "Assistants" + ], + "summary": "Cancels a run that is `in_progress`.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a run.": { + "$ref": "./examples/cancel_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps": { + "get": { + "operationId": "List_Run_Steps", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of run steps belonging to a run.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run and run steps belong to." + }, + { + "name": "run_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run the run steps belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunStepsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + }, + { + "name": "include[]", + "in": "query", + "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "step_details.tool_calls[*].file_search.results[*].content" + ], + "x-ms-enum": { + "name": "Include", + "modelAsString": true, + "values": [ + { + "value": "step_details.tool_calls[*].file_search.results[*].content" + } + ] + } + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunStepsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all run steps.": { + "$ref": "./examples/list_run_steps.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps/{step_id}": { + "get": { + "operationId": "Get_Run_Step", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run step.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which the run and run step belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to which the run step belongs." + }, + { + "in": "path", + "name": "step_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run step to retrieve." + }, + { + "name": "include[]", + "in": "query", + "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n", + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "step_details.tool_calls[*].file_search.results[*].content" + ], + "x-ms-enum": { + "name": "Include", + "modelAsString": true, + "values": [ + { + "value": "step_details.tool_calls[*].file_search.results[*].content" + } + ] + } + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runStepObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run step.": { + "$ref": "./examples/get_run_step.json" + } + } + } + }, + "/vector_stores": { + "get": { + "operationId": "List_Vector_Stores", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector stores.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoresOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoresResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector stores.": { + "$ref": "./examples/list_vector_stores.json" + } + } + }, + "post": { + "operationId": "Create_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreRequest" + } + } + } + }, + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store.": { + "$ref": "./examples/create_vector_store.json" + } + } + } + }, + "/vector_stores/{vector_store_id}": { + "get": { + "operationId": "Get_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store.": { + "$ref": "./examples/retrieve_vector_store.json" + } + } + }, + "post": { + "operationId": "Modify_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Modifies a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/updateVectorStoreRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } + } + }, + "delete": { + "operationId": "Delete_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Delete a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteVectorStoreResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a vector store.": { + "$ref": "./examples/delete_vector_store.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/files": { + "get": { + "operationId": "List_Vector_Store_Files", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector store files.", + "parameters": [ + { + "name": "vector_store_id", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", + "schema": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesFilter", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoreFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector store files.": { + "$ref": "./examples/list_vector_store_files.json" + } + } + }, + "post": { + "operationId": "Create_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store for which to create a File.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreFileRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store file.": { + "$ref": "./examples/create_vector_store_file.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/files/{file_id}": { + "get": { + "operationId": "Get_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store file.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string", + "example": "file-abc123" + }, + "description": "The ID of the file being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store file.": { + "$ref": "./examples/retrieve_vector_store_file.json" + } + } + }, + "delete": { + "operationId": "Delete_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteVectorStoreFileResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a vector store file.": { + "$ref": "./examples/delete_vector_store_file.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches": { + "post": { + "operationId": "Create_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store file batch.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store for which to create a File Batch.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreFileBatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store file batch.": { + "$ref": "./examples/create_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}": { + "get": { + "operationId": "Get_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store file batch.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store that the file batch belongs to." + }, + { + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_b_abc123" + }, + "description": "The ID of the file batch being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store file batch.": { + "$ref": "./examples/retrieve_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel": { + "post": { + "operationId": "Cancel_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store that the file batch belongs to." + }, + { + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file batch to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a vector store file batch.": { + "$ref": "./examples/cancel_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}/files": { + "get": { + "operationId": "List_Vector_Store_File_Batch_Files", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector store files in a batch.", + "parameters": [ + { + "name": "vector_store_id", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "batch_id", + "in": "path", + "description": "The ID of the file batch that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", + "schema": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesFilter", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2025-01-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoreFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector store files in a batch.": { + "$ref": "./examples/list_vector_store_files.json" + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/error" + } + } + }, + "errorBase": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/innerError" + } + } + }, + "innerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "innerErrorCode": { + "description": "Error codes for the inner error object.", + "enum": [ + "ResponsibleAIPolicyViolation" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "ResponsibleAIPolicyViolation", + "description": "The prompt violated one of more content filter rules." + } + ] + } + }, + "dalleErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/dalleError" + } + } + }, + "dalleError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/dalleInnerError" + } + } + }, + "dalleInnerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + } + } + }, + "contentFilterCompletionTextSpan": { + "type": "object", + "description": "Describes a span within generated completion text. Offset 0 is the first UTF32 code point of the completion text.", + "properties": { + "completion_start_offset": { + "description": "Offset of the UTF32 code point which begins the span.", + "type": "integer" + }, + "completion_end_offset": { + "description": "Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for non-empty spans.", + "type": "integer" + } + }, + "required": [ + "completion_start_offset", + "completion_end_offset" + ] + }, + "contentFilterResultBase": { + "type": "object", + "properties": { + "filtered": { + "type": "boolean" + } + }, + "required": [ + "filtered" + ] + }, + "contentFilterSeverityResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "severity": { + "type": "string", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "value": "safe", + "description": "General content or related content in generic or non-harmful contexts." + }, + { + "value": "low", + "description": "Harmful content at a low intensity and risk level." + }, + { + "value": "medium", + "description": "Harmful content at a medium intensity and risk level." + }, + { + "value": "high", + "description": "Harmful content at a high intensity and risk level." + } + ] + } + } + } + } + ], + "required": [ + "severity", + "filtered" + ] + }, + "contentFilterDetectedResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "detected": { + "type": "boolean" + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCitationResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "citation": { + "type": "object", + "properties": { + "URL": { + "type": "string" + }, + "license": { + "type": "string" + } + } + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCompletionTextSpansResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/contentFilterCompletionTextSpan" + } + } + } + } + ], + "required": [ + "detected", + "filtered", + "details" + ] + }, + "contentFilterIdResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "id": { + "type": "string" + } + } + } + ], + "required": [ + "id", + "filtered" + ] + }, + "contentFilterResultsBase": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "$ref": "#/components/schemas/contentFilterDetailedResults" + }, + "error": { + "$ref": "#/components/schemas/errorBase" + } + } + }, + "contentFilterPromptResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "indirect_attack": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "contentFilterChoiceResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "protected_material_text": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + }, + { + "properties": { + "protected_material_code": { + "$ref": "#/components/schemas/contentFilterDetectedWithCitationResult" + } + } + }, + { + "properties": { + "ungrounded_material": { + "$ref": "#/components/schemas/contentFilterDetectedWithCompletionTextSpansResult" + } + } + } + ] + }, + "contentFilterDetailedResults": { + "type": "object", + "description": "Content filtering results with a detail of content filter ids for the filtered segments.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "details": { + "items": { + "$ref": "#/components/schemas/contentFilterIdResult" + }, + "type": "array" + } + } + } + ], + "required": [ + "filtered", + "details" + ] + }, + "promptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "promptFilterResults": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/components/schemas/promptFilterResult" + } + }, + "dalleContentFilterResults": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + } + } + }, + "dalleFilterResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + { + "properties": { + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "$ref": "#/components/schemas/contentFilterDetailedResults" + } + } + } + ] + }, + "chatCompletionsRequestCommon": { + "type": "object", + "properties": { + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or `temperature` but not both.", + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.", + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "nullable": false + }, + "minItems": 1, + "maxItems": 4, + "description": "Array minimum size of 1 and maximum of 4" + } + ], + "default": null + }, + "max_tokens": { + "description": "The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). This is not compatible with o1 series models.", + "type": "integer", + "default": 4096 + }, + "max_completion_tokens": { + "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. This is only supported in o1 series models. Will expand the support to other models in future API release.", + "type": "integer", + "nullable": true + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "logit_bias": { + "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.", + "type": "object", + "nullable": true + }, + "store": { + "description": "Whether or not to store the output of this chat completion request for use in our model distillation or evaluation products.", + "type": "boolean", + "nullable": true + }, + "metadata": { + "description": "Developer-defined tags and values used for filtering completions in the stored completions dashboard.", + "type": "object", + "nullable": true, + "additionalProperties": { + "type": "string" + } + }, + "user": { + "description": "A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.", + "type": "string", + "example": "user-1234", + "nullable": false + } + } + }, + "createCompletionRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n", + "default": "<|endoftext|>", + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test." + }, + { + "type": "array", + "items": { + "type": "string", + "default": "", + "example": "This is a test." + } + } + ] + }, + "best_of": { + "type": "integer", + "default": 1, + "minimum": 0, + "maximum": 20, + "nullable": true, + "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "echo": { + "type": "boolean", + "default": false, + "nullable": true, + "description": "Echo back the prompt in addition to the completion\n" + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "x-oaiTypeLabel": "map", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n" + }, + "logprobs": { + "type": "integer", + "minimum": 0, + "maximum": 5, + "default": null, + "nullable": true, + "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n" + }, + "max_tokens": { + "type": "integer", + "minimum": 0, + "default": 16, + "example": 16, + "nullable": true, + "description": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n" + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "modalities": { + "$ref": "#/components/schemas/ChatCompletionModalities" + }, + "prediction": { + "nullable": true, + "x-oaiExpandable": true, + "description": "Configuration for a [Predicted Output](/docs/guides/predicted-outputs), which can greatly improve response times when large parts of the model response are known ahead of time. This is most common when you are regenerating a file with only minor changes to most of the content.", + "oneOf": [ + { + "$ref": "#/components/schemas/PredictionContent" + } + ] + }, + "audio": { + "type": "object", + "description": "Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).\n", + "required": [ + "voice", + "format" + ], + "x-oaiExpandable": true, + "properties": { + "voice": { + "type": "string", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ], + "description": "Specifies the voice type. Supported voices are `alloy`, `echo`, \n`fable`, `onyx`, `nova`, and `shimmer`.\n" + }, + "format": { + "type": "string", + "enum": [ + "wav", + "mp3", + "flac", + "opus", + "pcm16" + ], + "description": "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`. \n" + } + } + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.\n", + "default": null, + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "<|endoftext|>", + "example": "\n", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string", + "example": "[\"\\n\"]" + } + } + ] + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "suffix": { + "description": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n", + "default": null, + "nullable": true, + "type": "string", + "example": "test." + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "prompt" + ] + }, + "createCompletionResponse": { + "type": "object", + "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the completion." + }, + "choices": { + "type": "array", + "description": "The list of completion choices the model generated for the input prompt.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "logprobs", + "text" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n", + "enum": [ + "stop", + "length", + "content_filter" + ] + }, + "index": { + "type": "integer" + }, + "logprobs": { + "type": "object", + "nullable": true, + "properties": { + "text_offset": { + "type": "array", + "items": { + "type": "integer" + } + }, + "token_logprobs": { + "type": "array", + "items": { + "type": "number" + } + }, + "tokens": { + "type": "array", + "items": { + "type": "string" + } + }, + "top_logprobs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + }, + "text": { + "type": "string" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the completion was created." + }, + "model": { + "type": "string", + "description": "The model used for completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always \"text_completion\"", + "enum": [ + "text_completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "createChatCompletionRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsRequestCommon" + }, + { + "properties": { + "messages": { + "description": "A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + } + }, + "data_sources": { + "type": "array", + "description": " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI.", + "items": { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + } + }, + "reasoning_effort": { + "type": "string", + "description": "**o1 models only** \n\n Constrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n\nCurrently supported values are `low`, `medium`, and `high`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.", + "enum": [ + "low", + "medium", + "high" + ], + "default": "medium" + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n" + }, + "logprobs": { + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.", + "type": "boolean", + "default": false, + "nullable": true + }, + "top_logprobs": { + "description": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "type": "integer", + "minimum": 0, + "maximum": 20, + "nullable": true + }, + "max_tokens": { + "description": "The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.\n\nThe total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n", + "type": "integer", + "nullable": true + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs." + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, + "response_format": { + "description": "An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/ResponseFormatText" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonObject" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonSchema" + } + ], + "x-oaiExpandable": true + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.\n", + "default": null, + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string" + } + } + ] + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "tools": { + "type": "array", + "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n", + "items": { + "$ref": "#/components/schemas/chatCompletionTool" + } + }, + "tool_choice": { + "$ref": "#/components/schemas/chatCompletionToolChoiceOption" + }, + "function_call": { + "deprecated": true, + "description": "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if functions are present.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionFunctionCallOption" + } + ], + "x-oaiExpandable": true + }, + "functions": { + "deprecated": true, + "description": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n", + "type": "array", + "minItems": 1, + "maxItems": 128, + "items": { + "$ref": "#/components/schemas/chatCompletionFunctions" + } + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + }, + "user_security_context": { + "$ref": "#/components/schemas/userSecurityContext" + } + }, + "required": [ + "messages" + ] + } + ] + }, + "userSecurityContext": { + "type": "object", + "description": "User security context contains several parameters that describe the AI application itself, and the end user that interacts with the AI application. These fields assist your security operations teams to investigate and mitigate security incidents by providing a comprehensive approach to protecting your AI applications. [Learn more](https://aka.ms/TP4AI/Documentation/EndUserContext) about protecting AI applications using Microsoft Defender for Cloud.", + "properties": { + "application_name": { + "type": "string", + "description": "The name of the application. Sensitive personal information should not be included in this field." + }, + "end_user_id": { + "type": "string", + "format": "uuid", + "description": "This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application. Sensitive personal information should not be included in this field." + }, + "end_user_tenant_id": { + "type": "string", + "format": "uuid", + "description": "The Microsoft 365 tenant ID the end user belongs to. It's required when the generative AI application is multi tenant." + }, + "source_ip": { + "type": "string", + "description": "Captures the original client's IP address, accepting both IPv4 and IPv6 formats." + } + } + }, + "chatCompletionFunctions": { + "type": "object", + "deprecated": true, + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionCallOption": { + "type": "object", + "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide/](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.", + "additionalProperties": true + }, + "chatCompletionRequestMessage": { + "oneOf": [ + { + "$ref": "#/components/schemas/ChatCompletionRequestDeveloperMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestUserMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestToolMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestFunctionMessage" + } + ] + }, + "ChatCompletionRequestDeveloperMessage": { + "type": "object", + "title": "Developer message", + "description": "Developer-provided instructions that the model should follow, regardless of messages sent by the user.\nWith o1 models and newer, `developer` messages replace the previous `system` messages.", + "properties": { + "content": { + "description": "The contents of the developer message.", + "oneOf": [ + { + "type": "string", + "description": "The contents of the developer message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For developer messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestDeveloperMessageContentPart" + }, + "minItems": 1 + } + ] + }, + "role": { + "type": "string", + "enum": [ + "developer" + ], + "description": "The role of the messages author, in this case `developer`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestSystemMessage": { + "type": "object", + "title": "System message", + "properties": { + "content": { + "description": "The contents of the system message.", + "oneOf": [ + { + "type": "string", + "description": "The contents of the system message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For system messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + }, + "minItems": 1 + } + ] + }, + "role": { + "type": "string", + "enum": [ + "system" + ], + "description": "The role of the messages author, in this case `system`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestUserMessage": { + "type": "object", + "title": "User message", + "properties": { + "content": { + "description": "The contents of the user message.\n", + "oneOf": [ + { + "type": "string", + "description": "The text contents of the message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestUserMessageContentPart" + }, + "minItems": 1 + } + ], + "x-oaiExpandable": true + }, + "role": { + "type": "string", + "enum": [ + "user" + ], + "description": "The role of the messages author, in this case `user`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestAssistantMessage": { + "type": "object", + "title": "Assistant message", + "properties": { + "content": { + "nullable": true, + "oneOf": [ + { + "type": "string", + "description": "The contents of the assistant message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n" + }, + "refusal": { + "nullable": true, + "type": "string", + "description": "The refusal message by the assistant." + }, + "role": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the messages author, in this case `assistant`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + }, + "tool_calls": { + "$ref": "#/components/schemas/chatCompletionMessageToolCalls" + }, + "function_call": { + "type": "object", + "deprecated": true, + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "nullable": true, + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "arguments", + "name" + ] + } + }, + "required": [ + "role" + ] + }, + "chatCompletionRequestToolMessage": { + "type": "object", + "title": "Tool message", + "properties": { + "role": { + "type": "string", + "enum": [ + "tool" + ], + "description": "The role of the messages author, in this case `tool`." + }, + "content": { + "oneOf": [ + { + "type": "string", + "description": "The contents of the tool message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For tool messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestToolMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the tool message." + }, + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + } + }, + "required": [ + "role", + "content", + "tool_call_id" + ] + }, + "chatCompletionRequestFunctionMessage": { + "type": "object", + "title": "Function message", + "deprecated": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "content": { + "nullable": true, + "type": "string", + "description": "The contents of the function message." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "role", + "content", + "name" + ] + }, + "chatCompletionRequestDeveloperMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestSystemMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestUserMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartImage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartAudio" + } + ] + }, + "chatCompletionRequestAssistantMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + } + ] + }, + "chatCompletionRequestToolMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestMessageContentPartText": { + "type": "object", + "title": "Text content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "text" + ], + "description": "The type of the content part." + }, + "text": { + "type": "string", + "description": "The text content." + } + }, + "required": [ + "type", + "text" + ] + }, + "chatCompletionRequestMessageContentPartAudio": { + "type": "object", + "title": "Audio content part", + "description": "Learn about [audio inputs](/docs/guides/audio).\n", + "properties": { + "type": { + "type": "string", + "enum": [ + "input_audio" + ], + "description": "The type of the content part. Always `input_audio`." + }, + "input_audio": { + "type": "object", + "properties": { + "data": { + "type": "string", + "description": "Base64 encoded audio data." + }, + "format": { + "type": "string", + "enum": [ + "wav", + "mp3" + ], + "description": "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".\n" + } + }, + "required": [ + "data", + "format" + ] + } + }, + "required": [ + "type", + "input_audio" + ] + }, + "chatCompletionRequestMessageContentPartImage": { + "type": "object", + "title": "Image content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "image_url" + ], + "description": "The type of the content part." + }, + "image_url": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Either a URL of the image or the base64 encoded image data.", + "format": "uri" + }, + "detail": { + "type": "string", + "description": "Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).", + "enum": [ + "auto", + "low", + "high" + ], + "default": "auto" + } + }, + "required": [ + "url" + ] + } + }, + "required": [ + "type", + "image_url" + ] + }, + "chatCompletionRequestMessageContentPartRefusal": { + "type": "object", + "title": "Refusal content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "refusal" + ], + "description": "The type of the content part." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model." + } + }, + "required": [ + "type", + "refusal" + ] + }, + "azureChatExtensionConfiguration": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/azureChatExtensionType" + } + }, + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_search": "#/components/schemas/azureSearchChatExtensionConfiguration", + "azure_cosmos_db": "#/components/schemas/azureCosmosDBChatExtensionConfiguration", + "elasticsearch": "#/components/schemas/elasticsearchChatExtensionConfiguration", + "mongo_db": "#/components/schemas/mongoDBChatExtensionConfiguration", + "pinecone": "#/components/schemas/pineconeChatExtensionConfiguration" + } + } + }, + "azureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_cosmos_db", + "elasticsearch", + "mongo_db", + "pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure Search as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + }, + { + "name": "elasticsearch", + "value": "elasticsearch", + "description": "Represents the use of Elasticsearch® index as an Azure OpenAI chat extension." + }, + { + "name": "mongoDB", + "value": "mongo_db", + "description": "Represents the use of Mongo DB as an Azure OpenAI chat extension." + }, + { + "name": "pinecone", + "value": "pinecone", + "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension." + } + ] + } + }, + "azureSearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureSearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "azureSearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The absolute endpoint path for the Azure Search resource to use.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Search resource." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/azureSearchQueryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataIntegratedVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension." + }, + "azureSearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + }, + "image_vector_fields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource." + }, + "azureSearchQueryType": { + "type": "string", + "description": "The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vector_simple_hybrid", + "vector_semantic_hybrid" + ], + "x-ms-enum": { + "name": "AzureSearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "semantic", + "value": "semantic", + "description": "Represents the semantic query parser for advanced semantic modeling." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + }, + { + "name": "vectorSimpleHybrid", + "value": "vector_simple_hybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vector_semantic_hybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "azureCosmosDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureCosmosDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "azureCosmosDBChatExtensionParameters": { + "required": [ + "authentication", + "container_name", + "database_name", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore." + }, + "azureCosmosDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource." + }, + "elasticsearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/elasticsearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "elasticsearch" + }, + "elasticsearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The endpoint of Elasticsearch®.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The index name of Elasticsearch®." + }, + "fields_mapping": { + "$ref": "#/components/schemas/elasticsearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/elasticsearchQueryType" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + }, + "elasticsearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource." + }, + "elasticsearchQueryType": { + "type": "string", + "description": "The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "vector" + ], + "x-ms-enum": { + "name": "ElasticsearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + } + ] + } + }, + "mongoDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Mongo DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/mongoDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "mongo_db" + }, + "mongoDBChatExtensionParameters": { + "required": [ + "authentication", + "app_name", + "collection_name", + "database_name", + "endpoint", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The name of the Mongo DB cluster endpoint." + }, + "database_name": { + "type": "string", + "description": "The name of the Mongo DB database." + }, + "collection_name": { + "type": "string", + "description": "The name of the Mongo DB Collection." + }, + "app_name": { + "type": "string", + "description": "The name of the Mongo DB Application." + }, + "index_name": { + "type": "string", + "description": "The The name of the Mongo DB index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/mongoDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Mongo DB." + }, + "mongoDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Mongo DB resource." + }, + "pineconeChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/pineconeChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "pinecone" + }, + "pineconeChatExtensionParameters": { + "required": [ + "authentication", + "embedding_dependency", + "environment", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "index_name": { + "type": "string", + "description": "The name of the Pinecone database index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/pineconeFieldMappingOptions" + }, + "embedding_dependency": { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions." + }, + "pineconeFieldMappingOptions": { + "required": [ + "content_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + } + }, + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource." + }, + "onYourDataAuthenticationOptions": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataAuthenticationType" + } + }, + "description": "The authentication options for Azure OpenAI On Your Data.", + "discriminator": { + "propertyName": "type", + "mapping": { + "api_key": "#/components/schemas/onYourDataApiKeyAuthenticationOptions", + "connection_string": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions", + "key_and_key_id": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions", + "encoded_api_key": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions", + "access_token": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions", + "system_assigned_managed_identity": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions", + "user_assigned_managed_identity": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions", + "username_and_password": "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + } + } + }, + "onYourDataContextProperty": { + "type": "string", + "description": "The context property.", + "enum": [ + "citations", + "intent", + "all_retrieved_documents" + ], + "x-ms-enum": { + "name": "OnYourDataContextProperty", + "modelAsString": true, + "values": [ + { + "name": "citations", + "value": "citations", + "description": "The `citations` property." + }, + { + "name": "intent", + "value": "intent", + "description": "The `intent` property." + }, + { + "name": "allRetrievedDocuments", + "value": "all_retrieved_documents", + "description": "The `all_retrieved_documents` property." + } + ] + } + }, + "onYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "key_and_key_id", + "encoded_api_key", + "access_token", + "system_assigned_managed_identity", + "user_assigned_managed_identity", + "username_and_password" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "key_and_key_id", + "description": "Authentication via key and key ID pair." + }, + { + "name": "encodedApiKey", + "value": "encoded_api_key", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + }, + { + "name": "usernameAndPassword", + "value": "username_and_password", + "description": "Authentication via username and password." + } + ] + } + }, + "onYourDataApiKeyAuthenticationOptions": { + "required": [ + "key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "api_key" + }, + "onYourDataConnectionStringAuthenticationOptions": { + "required": [ + "connection_string" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "onYourDataKeyAndKeyIdAuthenticationOptions": { + "required": [ + "key", + "key_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The Elasticsearch key to use for authentication." + }, + "key_id": { + "type": "string", + "description": "The Elasticsearch key ID to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "key_and_key_id" + }, + "onYourDataEncodedApiKeyAuthenticationOptions": { + "required": [ + "encoded_api_key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "encoded_api_key": { + "type": "string", + "description": "The Elasticsearch encoded API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "encoded_api_key" + }, + "onYourDataAccessTokenAuthenticationOptions": { + "required": [ + "access_token" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "access_token" + }, + "onYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "onYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "required": [ + "managed_identity_resource_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "onYourDataUsernameAndPasswordAuthenticationOptions": { + "required": [ + "username", + "password" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a username and a password.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "username": { + "type": "string", + "description": "The username to use for authentication." + }, + "password": { + "type": "string", + "description": "The password. to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "username_and_password" + }, + "onYourDataVectorizationSource": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataVectorizationSourceType" + } + }, + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "discriminator": { + "propertyName": "type", + "mapping": { + "endpoint": "#/components/schemas/onYourDataEndpointVectorizationSource", + "deployment_name": "#/components/schemas/onYourDataDeploymentNameVectorizationSource", + "integrated": "#/components/schemas/onYourDataIntegratedVectorizationSource", + "model_id": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + } + }, + "onYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name", + "integrated", + "model_id" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + }, + { + "name": "integrated", + "value": "integrated", + "description": "Represents the integrated vectorizer defined within the search resource." + }, + { + "name": "modelId", + "value": "model_id", + "description": "Represents a specific embedding model ID as defined in the search service.\nCurrently only supported by Elasticsearch®." + } + ] + } + }, + "onYourDataEndpointVectorizationSource": { + "required": [ + "authentication", + "endpoint" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "endpoint": { + "type": "string", + "description": "Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.", + "format": "uri" + }, + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + } + ] + }, + "dimensions": { + "type": "integer", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.", + "format": "int32" + } + } + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "onYourDataDeploymentNameVectorizationSource": { + "required": [ + "deployment_name" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "deployment_name": { + "type": "string", + "description": "Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks." + }, + "dimensions": { + "type": "integer", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.", + "format": "int32" + } + } + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "onYourDataIntegratedVectorizationSource": { + "description": "Represents the integrated vectorizer defined within the search resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "integrated" + }, + "onYourDataModelIdVectorizationSource": { + "required": [ + "model_id" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a search service model ID. Currently only supported by Elasticsearch®.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "model_id": { + "type": "string", + "description": "Specifies the model ID to use for vectorization. This model ID must be defined in the search service." + } + } + } + ], + "x-ms-discriminator-value": "model_id" + }, + "azureChatExtensionsMessageContext": { + "type": "object", + "properties": { + "citations": { + "type": "array", + "description": "The data source retrieval result, used to generate the assistant message in the response.", + "items": { + "$ref": "#/components/schemas/citation" + }, + "x-ms-identifiers": [] + }, + "intent": { + "type": "string", + "description": "The detected intent from the chat history, used to pass to the next turn to carry over the context." + }, + "all_retrieved_documents": { + "type": "array", + "description": "All the retrieved documents.", + "items": { + "$ref": "#/components/schemas/retrievedDocument" + } + } + }, + "description": " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." + }, + "citation": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the citation." + }, + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The URL of the citation." + }, + "filepath": { + "type": "string", + "description": "The file path of the citation." + }, + "chunk_id": { + "type": "string", + "description": "The chunk ID of the citation." + }, + "rerank_score": { + "type": "number", + "description": "The rerank score of the retrieved document.", + "format": "double" + } + }, + "description": "citation information for a chat completions response message." + }, + "retrievedDocument": { + "type": "object", + "description": "The retrieved document.", + "required": [ + "search_queries", + "data_source_index", + "original_search_score" + ], + "allOf": [ + { + "$ref": "#/components/schemas/citation" + }, + { + "properties": { + "search_queries": { + "type": "array", + "description": "The search queries used to retrieve the document.", + "items": { + "type": "string" + } + }, + "data_source_index": { + "type": "integer", + "description": "The index of the data source.", + "format": "int32" + }, + "original_search_score": { + "type": "number", + "description": "The original search score of the retrieved document.", + "format": "double" + }, + "filter_reason": { + "$ref": "#/components/schemas/filterReason", + "description": "Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset." + } + } + } + ] + }, + "filterReason": { + "type": "string", + "description": "The filtering reason of the retrieved document.", + "enum": [ + "score", + "rerank" + ], + "x-ms-enum": { + "name": "FilterReason", + "modelAsString": true, + "values": [ + { + "name": "score", + "value": "score", + "description": "The document is filtered by original search score threshold defined by `strictness` configure." + }, + { + "name": "rerank", + "value": "rerank", + "description": "The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure." + } + ] + } + }, + "chatCompletionMessageToolCall": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "$ref": "#/components/schemas/toolCallType" + }, + "function": { + "type": "object", + "description": "The function that the model called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "toolCallType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool call, in this case `function`.", + "x-ms-enum": { + "name": "ToolCallType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool call type is function." + } + ] + } + }, + "chatCompletionRequestMessageTool": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "nullable": true, + "properties": { + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "tool_call_id", + "content" + ] + }, + "chatCompletionRequestMessageFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "description": "Deprecated. Message that represents a function.", + "nullable": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "name": { + "type": "string", + "description": "The contents of the message." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "function_call_id", + "content" + ] + }, + "createChatCompletionResponse": { + "type": "object", + "description": "Represents a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "message", + "logprobs" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ] + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + }, + "message": { + "$ref": "#/components/schemas/chatCompletionResponseMessage" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion`.", + "enum": [ + "chat.completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "createChatCompletionStreamResponse": { + "type": "object", + "description": "Represents a streamed chunk of a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion. Each chunk has the same ID." + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.\n", + "items": { + "type": "object", + "required": [ + "delta", + "finish_reason", + "index" + ], + "properties": { + "delta": { + "$ref": "#/components/schemas/chatCompletionStreamResponseDelta" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + }, + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ], + "nullable": true + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp." + }, + "model": { + "type": "string", + "description": "The model to generate the completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion.chunk`.", + "enum": [ + "chat.completion.chunk" + ], + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "chatCompletionStreamResponseDelta": { + "type": "object", + "description": "A chat completion delta generated by streamed model responses.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the chunk message.", + "nullable": true + }, + "function_call": { + "deprecated": true, + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + } + }, + "tool_calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCallChunk" + } + }, + "role": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool" + ], + "description": "The role of the author of this message." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + } + } + }, + "chatCompletionMessageToolCallChunk": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + } + } + }, + "required": [ + "index" + ] + }, + "chatCompletionStreamOptions": { + "description": "Options for streaming response. Only set this when you set `stream: true`.\n", + "type": "object", + "nullable": true, + "default": null, + "properties": { + "include_usage": { + "type": "boolean", + "description": "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.\n" + } + } + }, + "chatCompletionChoiceLogProbs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content" + ] + }, + "chatCompletionTokenLogprob": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + }, + "top_logprobs": { + "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", + "type": "array", + "items": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + } + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "chatCompletionResponseMessage": { + "type": "object", + "description": "A chat completion message generated by the model.", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionResponseMessageRole" + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "function_call": { + "$ref": "#/components/schemas/chatCompletionFunctionCall" + }, + "audio": { + "type": "object", + "description": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).\n", + "x-oaiExpandable": true, + "required": [ + "id", + "expires_at", + "data", + "transcript" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for this audio response." + }, + "expires_at": { + "type": "integer", + "description": "The Unix timestamp (in seconds) for when this audio response will\nno longer be accessible on the server for use in multi-turn\nconversations.\n" + }, + "data": { + "type": "string", + "description": "Base64 encoded audio bytes generated by the model, in the format\nspecified in the request.\n" + }, + "transcript": { + "type": "string", + "description": "Transcript of the audio generated by the model." + } + } + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + }, + "required": [ + "role", + "content", + "refusal" + ] + }, + "chatCompletionResponseMessageRole": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the author of the response message." + }, + "chatCompletionToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.", + "enum": [ + "none", + "auto", + "required" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionNamedToolChoice" + } + ] + }, + "chatCompletionNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "ParallelToolCalls": { + "type": "boolean", + "description": "Whether to enable parallel function calling during tool use.", + "default": true + }, + "PredictionContent": { + "type": "object", + "title": "Static Content", + "description": "Static predicted output content, such as the content of a text file that is being regenerated.", + "required": [ + "content", + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the predicted content you want to provide. This type is currently always `content`.", + "enum": [ + "content" + ] + }, + "content": { + "x-oaiExpandable": true, + "description": "The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly.", + "oneOf": [ + { + "type": "string", + "title": "Text Content", + "description": "The content used for a Predicted Output. This is often the text of a file you are regenerating with minor changes." + }, + { + "type": "array", + "title": "Array of content parts", + "description": "An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text inputs.", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + } + ] + } + } + }, + "chatCompletionMessageToolCalls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "ChatCompletionModalities": { + "type": "array", + "description": "Output types that you would like the model to generate for this request.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To\nrequest that this model generate both text and audio responses, you can\nuse:\n\n`[\"text\", \"audio\"]`\n", + "items": { + "type": "string", + "enum": [ + "text", + "audio" + ] + } + }, + "chatCompletionFunctionCall": { + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "completionUsage": { + "type": "object", + "description": "Usage statistics for the completion request.", + "properties": { + "prompt_tokens": { + "type": "integer", + "description": "Number of tokens in the prompt." + }, + "completion_tokens": { + "type": "integer", + "description": "Number of tokens in the generated completion." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used in the request (prompt + completion)." + }, + "prompt_tokens_details": { + "type": "object", + "description": "Details of the prompt tokens.", + "properties": { + "audio_tokens": { + "type": "integer", + "description": "Audio input tokens present in the prompt." + }, + "cached_tokens": { + "type": "integer", + "description": "The number of cached prompt tokens." + } + } + }, + "completion_tokens_details": { + "type": "object", + "description": "Breakdown of tokens used in a completion.", + "properties": { + "accepted_prediction_tokens": { + "type": "integer", + "description": "When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion." + }, + "audio_tokens": { + "type": "integer", + "description": "Audio input tokens generated by the model." + }, + "reasoning_tokens": { + "type": "integer", + "description": "Tokens generated by the model for reasoning." + }, + "rejected_prediction_tokens": { + "type": "integer", + "description": "When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits." + } + } + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + }, + "chatCompletionTool": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "$ref": "#/components/schemas/FunctionObject" + } + }, + "required": [ + "type", + "function" + ] + }, + "FunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "additionalProperties": true + }, + "FunctionObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling)." + } + }, + "required": [ + "name" + ] + }, + "ResponseFormatText": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `text`", + "enum": [ + "text" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonObject": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_object`", + "enum": [ + "json_object" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonSchemaSchema": { + "type": "object", + "description": "The schema for the response format, described as a JSON Schema object.", + "additionalProperties": true + }, + "ResponseFormatJsonSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_schema`", + "enum": [ + "json_schema" + ] + }, + "json_schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the response format is for, used by the model to determine how to respond in the format." + }, + "name": { + "type": "string", + "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "schema": { + "$ref": "#/components/schemas/ResponseFormatJsonSchemaSchema" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`." + } + }, + "required": [ + "schema", + "name" + ] + } + }, + "required": [ + "type", + "json_schema" + ] + }, + "chatCompletionChoiceCommon": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "finish_reason": { + "type": "string" + } + } + }, + "createTranslationRequest": { + "type": "object", + "description": "Translation request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file to translate.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + } + }, + "required": [ + "file" + ] + }, + "audioResponse": { + "description": "Translation or transcription response when response_format was json", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Translated or transcribed text." + } + }, + "required": [ + "text" + ] + }, + "audioVerboseResponse": { + "description": "Translation or transcription response when response_format was verbose_json", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "properties": { + "task": { + "type": "string", + "description": "Type of audio task.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "language": { + "type": "string", + "description": "Language." + }, + "duration": { + "type": "number", + "description": "Duration." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioSegment" + } + }, + "words": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioWord" + } + } + } + } + ], + "required": [ + "text" + ] + }, + "audioResponseFormat": { + "title": "AudioResponseFormat", + "description": "Defines the format of the output.", + "enum": [ + "json", + "text", + "srt", + "verbose_json", + "vtt" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true + } + }, + "createTranscriptionRequest": { + "type": "object", + "description": "Transcription request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file object to transcribe.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "language": { + "type": "string", + "description": "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." + }, + "timestamp_granularities[]": { + "type": "array", + "description": "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ] + }, + "default": [ + "segment" + ] + } + }, + "required": [ + "file" + ] + }, + "audioSegment": { + "type": "object", + "description": "Transcription or translation segment.", + "properties": { + "id": { + "type": "integer", + "description": "Segment identifier." + }, + "seek": { + "type": "number", + "description": "Offset of the segment." + }, + "start": { + "type": "number", + "description": "Segment start offset." + }, + "end": { + "type": "number", + "description": "Segment end offset." + }, + "text": { + "type": "string", + "description": "Segment text." + }, + "tokens": { + "type": "array", + "items": { + "type": "number", + "nullable": false + }, + "description": "Tokens of the text." + }, + "temperature": { + "type": "number", + "description": "Temperature." + }, + "avg_logprob": { + "type": "number", + "description": "Average log probability." + }, + "compression_ratio": { + "type": "number", + "description": "Compression ratio." + }, + "no_speech_prob": { + "type": "number", + "description": "Probability of 'no speech'." + } + } + }, + "audioWord": { + "type": "object", + "description": "Transcription or translation word.", + "properties": { + "word": { + "type": "string", + "description": "Word" + }, + "start": { + "type": "number", + "description": "Word start offset." + }, + "end": { + "type": "number", + "description": "Word end offset." + } + } + }, + "createSpeechRequest": { + "type": "object", + "description": "Speech request.", + "properties": { + "input": { + "type": "string", + "description": "The text to synthesize audio for. The maximum length is 4096 characters.", + "maxLength": 4096 + }, + "voice": { + "type": "string", + "description": "The voice to use for speech synthesis.", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ] + }, + "response_format": { + "type": "string", + "description": "The format to synthesize the audio in.", + "enum": [ + "mp3", + "opus", + "aac", + "flac", + "wav", + "pcm" + ] + }, + "speed": { + "description": "The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default.", + "type": "number", + "default": 1.0, + "minimum": 0.25, + "maximum": 4.0 + } + }, + "required": [ + "input", + "voice" + ] + }, + "imageQuality": { + "description": "The quality of the image that will be generated.", + "type": "string", + "enum": [ + "standard", + "hd" + ], + "default": "standard", + "x-ms-enum": { + "name": "Quality", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Standard quality creates images with standard quality.", + "name": "Standard" + }, + { + "value": "hd", + "description": "HD quality creates images with finer details and greater consistency across the image.", + "name": "HD" + } + ] + } + }, + "imagesResponseFormat": { + "description": "The format in which the generated images are returned.", + "type": "string", + "enum": [ + "url", + "b64_json" + ], + "default": "url", + "x-ms-enum": { + "name": "ImagesResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "url", + "description": "The URL that provides temporary access to download the generated images.", + "name": "Url" + }, + { + "value": "b64_json", + "description": "The generated images are returned as base64 encoded string.", + "name": "Base64Json" + } + ] + } + }, + "imageSize": { + "description": "The size of the generated images.", + "type": "string", + "enum": [ + "256x256", + "512x512", + "1792x1024", + "1024x1792", + "1024x1024" + ], + "default": "1024x1024", + "x-ms-enum": { + "name": "Size", + "modelAsString": true, + "values": [ + { + "value": "256x256", + "description": "The desired size of the generated image is 256x256 pixels. Only supported for dall-e-2.", + "name": "Size256x256" + }, + { + "value": "512x512", + "description": "The desired size of the generated image is 512x512 pixels. Only supported for dall-e-2.", + "name": "Size512x512" + }, + { + "value": "1792x1024", + "description": "The desired size of the generated image is 1792x1024 pixels. Only supported for dall-e-3.", + "name": "Size1792x1024" + }, + { + "value": "1024x1792", + "description": "The desired size of the generated image is 1024x1792 pixels. Only supported for dall-e-3.", + "name": "Size1024x1792" + }, + { + "value": "1024x1024", + "description": "The desired size of the generated image is 1024x1024 pixels.", + "name": "Size1024x1024" + } + ] + } + }, + "imageStyle": { + "description": "The style of the generated images.", + "type": "string", + "enum": [ + "vivid", + "natural" + ], + "default": "vivid", + "x-ms-enum": { + "name": "Style", + "modelAsString": true, + "values": [ + { + "value": "vivid", + "description": "Vivid creates images that are hyper-realistic and dramatic.", + "name": "Vivid" + }, + { + "value": "natural", + "description": "Natural creates images that are more natural and less hyper-realistic.", + "name": "Natural" + } + ] + } + }, + "imageGenerationsRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "A text description of the desired image(s). The maximum length is 4000 characters.", + "type": "string", + "format": "string", + "example": "a corgi in a field", + "minLength": 1 + }, + "n": { + "description": "The number of images to generate.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "default": 1 + }, + "size": { + "$ref": "#/components/schemas/imageSize" + }, + "response_format": { + "$ref": "#/components/schemas/imagesResponseFormat" + }, + "user": { + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.", + "type": "string", + "format": "string", + "example": "user123456" + }, + "quality": { + "$ref": "#/components/schemas/imageQuality" + }, + "style": { + "$ref": "#/components/schemas/imageStyle" + } + }, + "required": [ + "prompt" + ] + }, + "generateImagesResponse": { + "type": "object", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "The unix timestamp when the operation was created.", + "example": "1676540381" + }, + "data": { + "type": "array", + "description": "The result data of the operation, if successful", + "items": { + "$ref": "#/components/schemas/imageResult" + } + } + }, + "required": [ + "created", + "data" + ] + }, + "imageResult": { + "type": "object", + "description": "The image url or encoded image if successful, and an error otherwise.", + "properties": { + "url": { + "type": "string", + "description": "The image url.", + "example": "https://www.contoso.com" + }, + "b64_json": { + "type": "string", + "description": "The base64 encoded image" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + } + } + }, + "line": { + "type": "object", + "description": "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.", + "properties": { + "text": { + "type": "string" + }, + "spans": { + "type": "array", + "description": "An array of spans that represent detected objects and its bounding box information.", + "items": { + "$ref": "#/components/schemas/span" + } + } + }, + "required": [ + "text", + "spans" + ] + }, + "span": { + "type": "object", + "description": "A span object that represents a detected object and its bounding box information.", + "properties": { + "text": { + "type": "string", + "description": "The text content of the span that represents the detected object." + }, + "offset": { + "type": "integer", + "description": "The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints." + }, + "length": { + "type": "integer", + "description": "The length of the span in characters, measured in Unicode codepoints." + }, + "polygon": { + "type": "array", + "description": "An array of objects representing points in the polygon that encloses the detected object.", + "items": { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "The x-coordinate of the point." + }, + "y": { + "type": "number", + "description": "The y-coordinate of the point." + } + } + } + } + }, + "required": [ + "text", + "offset", + "length", + "polygon" + ] + }, + "runCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "properties": { + "completion_tokens": { + "type": "integer", + "description": "Number of completion tokens used over the course of the run." + }, + "prompt_tokens": { + "type": "integer", + "description": "Number of prompt tokens used over the course of the run." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "nullable": true + }, + "runStepCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "properties": { + "completion_tokens": { + "type": "integer", + "description": "Number of completion tokens used over the course of the run step." + }, + "prompt_tokens": { + "type": "integer", + "description": "Number of prompt tokens used over the course of the run step." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "nullable": true + }, + "assistantsApiResponseFormatOption": { + "description": "Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.", + "oneOf": [ + { + "type": "string", + "description": "`auto` is the default value\n", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AssistantsApiResponseFormatOption", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + }, + { + "$ref": "#/components/schemas/ResponseFormatText" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonObject" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonSchema" + } + ] + }, + "assistantsApiResponseFormat": { + "type": "object", + "description": "An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed.\n", + "properties": { + "type": { + "type": "string", + "enum": [ + "text", + "json_object" + ], + "x-ms-enum": { + "name": "AssistantsApiResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "text" + }, + { + "value": "json_object" + } + ] + }, + "example": "json_object", + "default": "text", + "description": "Must be one of `text` or `json_object`." + } + } + }, + "assistantObject": { + "type": "object", + "title": "Assistant", + "description": "Represents an `assistant` that can call the model and use tools.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant`.", + "type": "string", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "name": "AssistantObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant", + "description": "The object type, which is always assistant" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the assistant was created.", + "type": "integer" + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "maxLength": 256, + "nullable": true + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "maxLength": 512, + "nullable": true + }, + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "type": "string" + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 256,000 characters.\n", + "type": "string", + "maxLength": 256000, + "nullable": true + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "metadata" + ] + }, + "createAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 256,000 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256000 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "vector_stores": { + "type": "array", + "description": "A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.\n", + "maxItems": 10000, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AutoChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + } + }, + "required": [ + "type", + "static" + ] + } + ] + }, + "metadata": { + "type": "object", + "description": "Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "x-oaiTypeLabel": "map" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "vector_store_ids" + ] + }, + { + "required": [ + "vector_stores" + ] + } + ] + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "model" + ] + }, + "modifyAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 32768 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + } + }, + "deleteAssistantResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "name": "DeleteAssistantResponseState", + "modelAsString": true, + "values": [ + { + "value": "assistant.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listAssistantsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/assistantObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "assistantToolsCode": { + "type": "object", + "title": "Code interpreter tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `code_interpreter`", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "assistantToolsCodeType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFileSearch": { + "type": "object", + "title": "FileSearch tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `file_search`", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "assistantToolsFileSearchType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "Overrides for the file search tool.", + "properties": { + "max_num_results": { + "type": "integer", + "minimum": 1, + "maximum": 50, + "description": "The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. \n" + } + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFileSearchTypeOnly": { + "type": "object", + "title": "FileSearch tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `file_search`", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "assistantToolsFileSearchType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFunction": { + "type": "object", + "title": "Function tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `function`", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "assistantToolsFunction", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name", + "parameters", + "description" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "truncationObject": { + "type": "object", + "title": "Thread Truncation Controls", + "description": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "properties": { + "type": { + "type": "string", + "description": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "enum": [ + "auto", + "last_messages" + ], + "x-ms-enum": { + "name": "TruncationType", + "modelAsString": true, + "values": [ + { + "value": "auto" + }, + { + "value": "last_messages" + } + ] + } + }, + "last_messages": { + "type": "integer", + "description": "The number of most recent messages from the thread when constructing the context for the run.", + "minimum": 1, + "nullable": true + } + }, + "required": [ + "type" + ] + }, + "assistantsApiToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling a tool.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ], + "x-ms-enum": { + "name": "AssistantsApiToolChoiceOption", + "modelAsString": true, + "values": [ + { + "value": "none" + }, + { + "value": "auto" + } + ] + } + }, + { + "$ref": "#/components/schemas/assistantsNamedToolChoice" + } + ] + }, + "assistantsNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific tool.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function", + "code_interpreter", + "file_search" + ], + "description": "The type of the tool. If type is `function`, the function name must be set", + "x-ms-enum": { + "name": "AssistantsNamedToolChoiceType", + "modelAsString": true, + "values": [ + { + "value": "function" + }, + { + "value": "code_interpreter" + }, + { + "value": "file_search" + } + ] + } + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type" + ] + }, + "runObject": { + "type": "object", + "title": "A run on a thread", + "description": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run`.", + "type": "string", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "name": "runObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run", + "description": "The run object type which is always thread.run" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run was created.", + "type": "integer" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "type": "string" + }, + "assistant_id": { + "description": "The ID of the assistant used for execution of this run.", + "type": "string" + }, + "status": { + "description": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "queued", + "description": "The queued state" + }, + { + "value": "in_progress", + "description": "The in_progress state" + }, + { + "value": "requires_action", + "description": "The required_action state" + }, + { + "value": "cancelling", + "description": "The cancelling state" + }, + { + "value": "cancelled", + "description": "The cancelled state" + }, + { + "value": "failed", + "description": "The failed state" + }, + { + "value": "completed", + "description": "The completed state" + }, + { + "value": "expired", + "description": "The expired state" + } + ] + } + }, + "required_action": { + "type": "object", + "description": "Details on the action required to continue the run. Will be `null` if no action is required.", + "nullable": true, + "properties": { + "type": { + "description": "For now, this is always `submit_tool_outputs`.", + "type": "string", + "enum": [ + "submit_tool_outputs" + ] + }, + "submit_tool_outputs": { + "type": "object", + "description": "Details on the tool outputs needed for this run to continue.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list of the relevant tool calls.", + "items": { + "$ref": "#/components/schemas/runToolCallObject" + } + } + }, + "required": [ + "tool_calls" + ] + } + }, + "required": [ + "type", + "submit_tool_outputs" + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server failed to respond to request due to server error" + }, + { + "value": "rate_limit_exceeded", + "description": "The server failed to respond to request due to rate limit exceeded" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the run will expire.", + "type": "integer" + }, + "started_at": { + "description": "The Unix timestamp (in seconds) for when the run was started.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run was completed.", + "type": "integer", + "nullable": true + }, + "incomplete_details": { + "description": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "type": "object", + "nullable": true, + "properties": { + "reason": { + "description": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "type": "string", + "enum": [ + "max_completion_tokens", + "max_prompt_tokens" + ], + "x-ms-enum": { + "name": "IncompleteDetailsReason", + "modelAsString": true, + "values": [ + { + "value": "max_completion_tokens" + }, + { + "value": "max_prompt_tokens" + } + ] + } + } + } + }, + "model": { + "description": "The model that the assistant used for this run.", + "type": "string" + }, + "instructions": { + "description": "The instructions that the assistant used for this run.", + "type": "string" + }, + "tools": { + "description": "The list of tools that the assistant used for this run.", + "default": [], + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "usage": { + "$ref": "#/components/schemas/runCompletionUsage" + }, + "temperature": { + "description": "The sampling temperature used for this run. If not set, defaults to 1.", + "type": "number", + "nullable": true + }, + "top_p": { + "description": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "type": "number", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "assistant_id", + "status", + "required_action", + "last_error", + "expires_at", + "started_at", + "cancelled_at", + "failed_at", + "completed_at", + "model", + "instructions", + "tools", + "metadata", + "usage", + "incomplete_details", + "max_prompt_tokens", + "max_completion_tokens", + "truncation_strategy", + "tool_choice", + "response_format" + ] + }, + "createRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the assistant to use to execute this run.", + "type": "string" + }, + "model": { + "description": "The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "additional_instructions": { + "description": "Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.", + "type": "string", + "nullable": true + }, + "additional_messages": { + "description": "Adds additional messages to the thread before creating the run.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + }, + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "listRunsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "modifyRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "submitToolOutputsRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_outputs": { + "description": "A list of tools for which the outputs are being submitted.", + "type": "array", + "items": { + "type": "object", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call in the `required_action` object within the run object the output is being submitted for." + }, + "output": { + "type": "string", + "description": "The output of the tool call to be submitted to continue the run." + } + } + } + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + } + }, + "required": [ + "tool_outputs" + ] + }, + "runToolCallObject": { + "type": "object", + "description": "Tool call objects", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint." + }, + "type": { + "type": "string", + "description": "The type of tool call the output is required for. For now, this is always `function`.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunToolCallObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model expects you to pass to the function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "createThreadAndRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the assistant to use to execute this run.", + "type": "string" + }, + "thread": { + "$ref": "#/components/schemas/createThreadRequest", + "description": "If no thread is provided, an empty thread will be created." + }, + "model": { + "description": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "threadObject": { + "type": "object", + "title": "Thread", + "description": "Represents a thread that contains [messages](/docs/api-reference/messages).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread`.", + "type": "string", + "enum": [ + "thread" + ], + "x-ms-enum": { + "name": "ThreadObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread", + "description": "The type of thread object which is always `thread`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the thread was created.", + "type": "integer" + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "tool_resources", + "metadata" + ] + }, + "createThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "messages": { + "description": "A list of [messages](/docs/api-reference/messages) to start the thread with.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "vector_stores": { + "type": "array", + "description": "A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.\n", + "maxItems": 10000, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AutoChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + } + }, + "required": [ + "type", + "static" + ] + } + ] + }, + "metadata": { + "type": "object", + "description": "Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "vector_store_ids" + ] + }, + { + "required": [ + "vector_stores" + ] + } + ] + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of File IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteThreadResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "name": "DeleteThreadResponseObjectState", + "modelAsString": true, + "values": [ + { + "value": "thread.deleted", + "description": "The delete thread response object state which is `thread.deleted`" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listThreadsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/threadObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageObject": { + "type": "object", + "title": "The message object", + "description": "Represents a message within a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message`.", + "type": "string", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "name": "MessageObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message", + "description": "The message object type which is `thread.message`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the message was created.", + "type": "integer" + }, + "thread_id": { + "description": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", + "type": "string" + }, + "status": { + "description": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "type": "string", + "enum": [ + "in_progress", + "incomplete", + "completed" + ], + "x-ms-enum": { + "name": "MessageObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "incomplete" + }, + { + "value": "completed" + } + ] + } + }, + "incomplete_details": { + "description": "On an incomplete message, details about why the message is incomplete.", + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason the message is incomplete.", + "enum": [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_expired", + "run_failed" + ], + "x-ms-enum": { + "name": "MessageObjectIncompleteReason", + "modelAsString": true, + "values": [ + { + "value": "content_filter" + }, + { + "value": "max_tokens" + }, + { + "value": "run_cancelled" + }, + { + "value": "run_expired" + }, + { + "value": "run_failed" + } + ] + } + } + }, + "nullable": true, + "required": [ + "reason" + ] + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the message was completed.", + "type": "integer", + "nullable": true + }, + "incomplete_at": { + "description": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "type": "integer", + "nullable": true + }, + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageObjectRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageContentTextObject" + } + ] + } + }, + "assistant_id": { + "description": "If applicable, the ID of the assistant that authored this message.", + "type": "string", + "nullable": true + }, + "run_id": { + "description": "If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.", + "type": "string", + "nullable": true + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message." + }, + "tools": { + "description": "The tools to add this file to.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearchTypeOnly" + } + ] + } + } + } + }, + "description": "A list of files attached to the message, and the tools they were added to.", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "status", + "incomplete_details", + "completed_at", + "incomplete_at", + "role", + "content", + "assistant_id", + "run_id", + "attachments", + "metadata" + ] + }, + "messageDeltaObject": { + "type": "object", + "title": "Message delta object", + "description": "Represents a message delta i.e. any changed fields on a message during streaming.\n", + "properties": { + "id": { + "description": "The identifier of the message, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message.delta`.", + "type": "string", + "enum": [ + "thread.message.delta" + ], + "x-ms-enum": { + "name": "MessageDeltaObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message.delta" + } + ] + } + }, + "delta": { + "description": "The delta containing the fields that have changed on the Message.", + "type": "object", + "properties": { + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageDeltaObjectDeltaRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageDeltaContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageDeltaContentTextObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "object", + "delta" + ] + }, + "createMessageRequest": { + "type": "object", + "additionalProperties": false, + "required": [ + "role", + "content" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "CreateMessageRequestRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + }, + "description": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.\n" + }, + "content": { + "type": "string", + "minLength": 1, + "maxLength": 256000, + "description": "The content of the message." + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message." + }, + "tools": { + "description": "The tools to add this file to.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearchTypeOnly" + } + ] + } + } + } + }, + "description": "A list of files attached to the message, and the tools they should be added to.", + "required": [ + "file_id", + "tools" + ], + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyMessageRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteMessageResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.message.deleted" + ], + "x-ms-enum": { + "name": "DeleteMessageResponseObject", + "modelAsString": true, + "values": [ + { + "value": "thread.message.deleted", + "description": "The delete message response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listMessagesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messageObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image File in the content of a message.", + "properties": { + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file", + "description": "The message content image file type" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image in the message content.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image_file" + ] + }, + "messageContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "messageContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "The message content text Object type" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFilePathObject" + } + ] + } + } + }, + "required": [ + "value", + "annotations" + ] + } + }, + "required": [ + "type", + "text" + ] + }, + "messageContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"retrieval\" tool to search files.", + "properties": { + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "FileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation", + "description": "The file citation object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_citation", + "start_index", + "end_index" + ] + }, + "messageContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "FilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path", + "description": "The file path object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_path", + "start_index", + "end_index" + ] + }, + "messageDeltaContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image File in the content of a message.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the content part in the message." + }, + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageDeltaContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image in the message content.", + "type": "string" + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the content part in the message." + }, + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageDeltaContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageDeltaContentTextAnnotationsFilePathObject" + } + ] + } + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the annotation in the text content part." + }, + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextAnnotationsFileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + }, + "quote": { + "description": "The specific quote in the file.", + "type": "string" + } + } + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the annotation in the text content part." + }, + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextAnnotationsFilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + } + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepObject": { + "type": "object", + "title": "Run steps", + "description": "Represents a step in execution of a run.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant.run.step``.", + "type": "string", + "enum": [ + "assistant.run.step" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant.run.step", + "description": "The object type, which is always `assistant.run.step`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run step was created.", + "type": "integer" + }, + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "type": "string" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was run.", + "type": "string" + }, + "run_id": { + "description": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", + "type": "string" + }, + "type": { + "description": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "type": "string", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation", + "description": "The message_creation run step" + }, + { + "value": "tool_calls", + "description": "The tool_calls run step" + } + ] + } + }, + "status": { + "description": "The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress", + "description": "The in_progress run status" + }, + { + "value": "cancelled", + "description": "The cancelled run status" + }, + { + "value": "failed", + "description": "The cancelled run status" + }, + { + "value": "completed", + "description": "The cancelled run status" + }, + { + "value": "expired", + "description": "The cancelled run status" + } + ] + } + }, + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsObject" + } + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run step. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server_error" + }, + { + "value": "rate_limit_exceeded", + "description": "The rate_limit_exceeded status" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expired_at": { + "description": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run step failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run step completed.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id", + "thread_id", + "run_id", + "type", + "status", + "step_details", + "last_error", + "expired_at", + "cancelled_at", + "failed_at", + "completed_at", + "metadata" + ] + }, + "runStepDeltaObject": { + "type": "object", + "title": "Run step delta object", + "description": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run.step.delta`.", + "type": "string", + "enum": [ + "thread.run.step.delta" + ], + "x-ms-enum": { + "name": "RunStepDeltaObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.delta" + } + ] + } + }, + "delta": { + "description": "The delta containing the fields that have changed on the run step.", + "type": "object", + "properties": { + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsObject" + } + ] + } + } + } + }, + "required": [ + "id", + "object", + "delta" + ] + }, + "listRunStepsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "runStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation``.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + }, + "required": [ + "message_id" + ] + } + }, + "required": [ + "type", + "message_creation" + ] + }, + "runStepDeltaStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation`.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + } + } + }, + "required": [ + "type" + ] + }, + "runStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval` or `function`.\n", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFileSearchObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type", + "tool_calls" + ] + }, + "runStepDeltaStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search` or `function`.\n", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsFileSearchObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "runStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "required": [ + "input", + "outputs" + ], + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "type", + "code_interpreter" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "logs" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "type", + "logs" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the output in the outputs array." + }, + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "logs" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputImageObjectType", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The index of the output in the outputs array." + }, + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeOutputImageObject", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The file ID of the image.", + "type": "string" + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsFileSearchObject": { + "title": "File search tool call", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `file_search` for this type of tool call.", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFileSearchObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "For now, this is always going to be an empty object.", + "properties": { + "results": { + "type": "array", + "description": "The results of the file search.", + "items": { + "$ref": "#/components/schemas/runStepDetailsToolCallsFileSearchResultObject" + } + } + } + } + }, + "required": [ + "id", + "type", + "file_search" + ] + }, + "runStepDetailsToolCallsFileSearchResultObject": { + "title": "File search tool call result", + "type": "object", + "description": "A result instance of the file search.", + "x-oaiTypeLabel": "map", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file that result was found in." + }, + "file_name": { + "type": "string", + "description": "The name of the file that result was found in." + }, + "score": { + "type": "number", + "description": "The score of the result. All values must be a floating point number between 0 and 1.", + "minimum": 0, + "maximum": 1 + }, + "content": { + "type": "array", + "description": "The content of the result that was found. The content is only included if requested via the include query parameter.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the content.", + "enum": [ + "text" + ] + }, + "text": { + "type": "string", + "description": "The text content of the file." + } + } + } + } + }, + "required": [ + "file_id", + "file_name", + "score" + ] + }, + "runStepDeltaStepDetailsToolCallsFileSearchObject": { + "title": "File search tool call", + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `retrieval` for this type of tool call.", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsFileSearchObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "For now, this is always going to be an empty object." + } + }, + "required": [ + "index", + "type", + "file_search" + ] + }, + "runStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", + "nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "runStepDeltaStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been submitted yet.", + "nullable": true + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "vectorStoreExpirationAfter": { + "type": "object", + "title": "Vector store expiration policy", + "description": "The expiration policy for a vector store.", + "properties": { + "anchor": { + "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.", + "type": "string", + "enum": [ + "last_active_at" + ], + "x-ms-enum": { + "name": "VectorStoreExpirationAfterAnchor", + "modelAsString": true, + "values": [ + { + "value": "last_active_at", + "description": "The anchor timestamp after which the expiration policy applies." + } + ] + } + }, + "days": { + "description": "The number of days after the anchor time that the vector store will expire.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + }, + "required": [ + "anchor", + "days" + ] + }, + "vectorStoreObject": { + "type": "object", + "title": "Vector store", + "description": "A vector store is a collection of processed files can be used by the `file_search` tool.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store`.", + "type": "string", + "enum": [ + "vector_store" + ] + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store was created.", + "type": "integer" + }, + "name": { + "description": "The name of the vector store.", + "type": "string" + }, + "usage_bytes": { + "description": "The total number of bytes used by the files in the vector store.", + "type": "integer" + }, + "file_counts": { + "type": "object", + "properties": { + "in_progress": { + "description": "The number of files that are currently being processed.", + "type": "integer" + }, + "completed": { + "description": "The number of files that have been successfully processed.", + "type": "integer" + }, + "failed": { + "description": "The number of files that have failed to process.", + "type": "integer" + }, + "cancelled": { + "description": "The number of files that were cancelled.", + "type": "integer" + }, + "total": { + "description": "The total number of files.", + "type": "integer" + } + }, + "required": [ + "in_progress", + "completed", + "failed", + "cancelled", + "total" + ] + }, + "status": { + "description": "The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.", + "type": "string", + "enum": [ + "expired", + "in_progress", + "completed" + ], + "x-ms-enum": { + "name": "VectorStoreObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "expired" + }, + { + "value": "in_progress" + }, + { + "value": "completed" + } + ] + } + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter" + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the vector store will expire.", + "type": "integer", + "nullable": true + }, + "last_active_at": { + "description": "The Unix timestamp (in seconds) for when the vector store was last active.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "status", + "last_active_at", + "name", + "bytes", + "file_counts", + "metadata" + ] + }, + "createVectorStoreRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_ids": { + "description": "A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "array", + "maxItems": 500, + "items": { + "type": "string" + } + }, + "name": { + "description": "The name of the vector store.", + "type": "string" + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter" + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "updateVectorStoreRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the vector store.", + "type": "string", + "nullable": true + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "listVectorStoresResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vectorStoreObject" + } + }, + "first_id": { + "type": "string", + "example": "vs_abc123" + }, + "last_id": { + "type": "string", + "example": "vs_abc456" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "deleteVectorStoreResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "vector_store.deleted" + ], + "x-ms-enum": { + "name": "DeleteVectorStoreResponseObject", + "modelAsString": true, + "values": [ + { + "value": "vector_store.deleted", + "description": "The delete vector store response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "vectorStoreFileObject": { + "type": "object", + "title": "Vector store files", + "description": "A list of files attached to a vector store.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store.file`.", + "type": "string", + "enum": [ + "vector_store.file" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "vector_store.file" + } + ] + } + }, + "usage_bytes": { + "description": "The total vector store usage in bytes. Note that this may be different from the original file size.", + "type": "integer" + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store file was created.", + "type": "integer" + }, + "vector_store_id": { + "description": "The ID of the vector store that the file is attached to.", + "type": "string" + }, + "status": { + "description": "The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.", + "type": "string", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "last_error": { + "type": "object", + "description": "The last error associated with this vector store file. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `invalid_file` or `unsupported_file`.", + "enum": [ + "server_error", + "unsupported_file", + "invalid_file" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectLastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error" + }, + { + "value": "unsupported_file" + }, + { + "value": "invalid_file" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "vector_store_id", + "status", + "last_error" + ] + }, + "otherChunkingStrategyResponseParam": { + "type": "object", + "title": "Other Chunking Strategy", + "description": "This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `other`.", + "enum": [ + "other" + ], + "x-ms-enum": { + "name": "OtherChunkingStrategyResponseParamType", + "modelAsString": true, + "values": [ + { + "value": "other" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "staticChunkingStrategyResponseParam": { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyResponseParamType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "$ref": "#/components/schemas/staticChunkingStrategy" + } + }, + "required": [ + "type", + "static" + ] + }, + "staticChunkingStrategy": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + }, + "autoChunkingStrategyRequestParam": { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ] + } + }, + "required": [ + "type" + ] + }, + "staticChunkingStrategyRequestParam": { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ] + }, + "static": { + "$ref": "#/components/schemas/staticChunkingStrategy" + } + }, + "required": [ + "type", + "static" + ] + }, + "chunkingStrategyRequestParam": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + }, + "createVectorStoreFileRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_id": { + "description": "A File ID that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "string" + }, + "chunking_strategy": { + "$ref": "#/components/schemas/chunkingStrategyRequestParam" + } + }, + "required": [ + "file_id" + ] + }, + "listVectorStoreFilesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + }, + "first_id": { + "type": "string", + "example": "file-abc123" + }, + "last_id": { + "type": "string", + "example": "file-abc456" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "deleteVectorStoreFileResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "vector_store.file.deleted" + ], + "x-ms-enum": { + "name": "DeleteVectorStoreFileResponseObject", + "modelAsString": true, + "values": [ + { + "value": "vector_store.file.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "vectorStoreFileBatchObject": { + "type": "object", + "title": "Vector store file batch", + "description": "A batch of files attached to a vector store.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store.file_batch`.", + "type": "string", + "enum": [ + "vector_store.files_batch" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchObjectType", + "modelAsString": true, + "values": [ + { + "value": "vector_store.files_batch" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store files batch was created.", + "type": "integer" + }, + "vector_store_id": { + "description": "The ID of the vector store that the File is attached to.", + "type": "string" + }, + "status": { + "description": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.", + "type": "string", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "file_counts": { + "type": "object", + "properties": { + "in_progress": { + "description": "The number of files that are currently being processed.", + "type": "integer" + }, + "completed": { + "description": "The number of files that have been processed.", + "type": "integer" + }, + "failed": { + "description": "The number of files that have failed to process.", + "type": "integer" + }, + "cancelled": { + "description": "The number of files that where cancelled.", + "type": "integer" + }, + "total": { + "description": "The total number of files.", + "type": "integer" + } + }, + "required": [ + "in_progress", + "completed", + "cancelled", + "failed", + "total" + ] + } + }, + "required": [ + "id", + "object", + "created_at", + "vector_store_id", + "status", + "file_counts" + ] + }, + "createVectorStoreFileBatchRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_ids": { + "description": "A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "array", + "minItems": 1, + "maxItems": 500, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "$ref": "#/components/schemas/chunkingStrategyRequestParam" + } + }, + "required": [ + "file_ids" + ] + }, + "assistantStreamEvent": { + "description": "Represents an event emitted when streaming a Run.\n\nEach event in a server-sent events stream has an `event` and `data` property:\n\n```\nevent: thread.created\ndata: {\"id\": \"thread_123\", \"object\": \"thread\", ...}\n```\n\nWe emit events whenever a new object is created, transitions to a new state, or is being\nstreamed in parts (deltas). For example, we emit `thread.run.created` when a new run\nis created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses\nto create a message during a run, we emit a `thread.message.created event`, a\n`thread.message.in_progress` event, many `thread.message.delta` events, and finally a\n`thread.message.completed` event.\n\nWe may add additional events over time, so we recommend handling unknown events gracefully\nin your code.", + "oneOf": [ + { + "$ref": "#/components/schemas/threadStreamEvent" + }, + { + "$ref": "#/components/schemas/runStreamEvent" + }, + { + "$ref": "#/components/schemas/runStepStreamEvent" + }, + { + "$ref": "#/components/schemas/messageStreamEvent" + }, + { + "$ref": "#/components/schemas/errorEvent" + }, + { + "$ref": "#/components/schemas/doneEvent" + } + ] + }, + "threadStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.created" + ], + "x-ms-enum": { + "name": "ThreadStreamEventEnum", + "modelAsString": true, + "values": [ + { + "value": "thread.created", + "description": "The thread created event" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/threadObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a new thread is created." + } + ] + }, + "runStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.created" + ], + "x-ms-enum": { + "name": "RunStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.run.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a new run is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.queued" + ], + "x-ms-enum": { + "name": "RunStreamEventQueued", + "modelAsString": true, + "values": [ + { + "value": "thread.run.queued" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `queued` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.in_progress" + ], + "x-ms-enum": { + "name": "RunStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.run.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to an `in_progress` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.requires_action" + ], + "x-ms-enum": { + "name": "RunStreamEventRequiresAction", + "modelAsString": true, + "values": [ + { + "value": "thread.run.requires_action" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `requires_action` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.completed" + ], + "x-ms-enum": { + "name": "RunStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.run.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.failed" + ], + "x-ms-enum": { + "name": "RunStreamEventFailed", + "modelAsString": true, + "values": [ + { + "value": "thread.run.failed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run fails." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.cancelling" + ], + "x-ms-enum": { + "name": "RunStreamEventCancelling", + "modelAsString": true, + "values": [ + { + "value": "thread.run.cancelling" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `cancelling` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.cancelled" + ], + "x-ms-enum": { + "name": "RunStreamEventCancelled", + "modelAsString": true, + "values": [ + { + "value": "thread.run.cancelled" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run is cancelled." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.expired" + ], + "x-ms-enum": { + "name": "RunStreamEventExpired", + "modelAsString": true, + "values": [ + { + "value": "thread.run.expired" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run expires." + } + ] + }, + "runStepStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.created" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.in_progress" + ], + "x-ms-enum": { + "name": "RunStepStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step moves to an `in_progress` state." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.delta" + ], + "x-ms-enum": { + "name": "RunStepStreamEventDelta", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.delta" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepDeltaObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when parts of a run step are being streamed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.completed" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.failed" + ], + "x-ms-enum": { + "name": "RunStepStreamEventFailed", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.failed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step fails." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.cancelled" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCancelled", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.cancelled" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is cancelled." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.expired" + ], + "x-ms-enum": { + "name": "RunStepStreamEventExpired", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.expired" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step expires." + } + ] + }, + "messageStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.created" + ], + "x-ms-enum": { + "name": "MessageStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.message.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.in_progress" + ], + "x-ms-enum": { + "name": "MessageStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.message.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message moves to an `in_progress` state." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.delta" + ], + "x-ms-enum": { + "name": "MessageStreamEventDelta", + "modelAsString": true, + "values": [ + { + "value": "thread.message.delta" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageDeltaObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when parts of a message are being streamed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.completed" + ], + "x-ms-enum": { + "name": "MessageStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.message.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.incomplete" + ], + "x-ms-enum": { + "name": "MessageStreamEventIncomplete", + "modelAsString": true, + "values": [ + { + "value": "thread.message.incomplete" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message ends before it is completed." + } + ] + }, + "errorEvent": { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "error" + ], + "x-ms-enum": { + "name": "ErrorEventEnum", + "modelAsString": true, + "values": [ + { + "value": "error" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/error" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when an error occurs. This can happen due to an internal server error or a timeout." + }, + "doneEvent": { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "done" + ], + "x-ms-enum": { + "name": "DoneEventEnum", + "modelAsString": true, + "values": [ + { + "value": "done" + } + ] + } + }, + "data": { + "type": "string", + "enum": [ + "[DONE]" + ], + "x-ms-enum": { + "name": "DoneEventDataEnum", + "modelAsString": true, + "values": [ + { + "value": "[DONE]" + } + ] + } + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a stream ends." + } + }, + "securitySchemes": { + "bearer": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": {} + } + }, + "x-tokenInfoFunc": "api.middleware.auth.bearer_auth", + "x-scopeValidateFunc": "api.middleware.auth.validate_scopes" + }, + "apiKey": { + "type": "apiKey", + "name": "api-key", + "in": "header" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.yaml new file mode 100644 index 000000000000..50d7fc87ac3a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2025-01-01-preview/inference.yaml @@ -0,0 +1,8782 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI Service API + description: Azure OpenAI APIs for completions and search + version: 2025-01-01-preview +servers: + - url: https://{endpoint}/openai + variables: + endpoint: + default: your-resource-name.openai.azure.com +security: + - bearer: + - api.read + - apiKey: [] +paths: + /deployments/{deployment-id}/completions: + post: + summary: Creates a completion for the provided prompt, parameters and chosen model. + operationId: Completions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: davinci + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionRequest" + example: + prompt: |- + Negate the following sentence.The price for bubblegum increased on thursday. + + Negated Sentence: + max_tokens: 50 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionResponse" + example: + model: davinci + object: text_completion + id: cmpl-4509KAos68kxOqpE2uYGw81j6m7uo + created: 1637097562 + choices: + - index: 0 + text: The price for bubblegum decreased on thursday. + logprobs: null + finish_reason: stop + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + /deployments/{deployment-id}/embeddings: + post: + summary: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. + operationId: embeddings_create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: ada-search-index-v1 + description: The deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + properties: + input: + description: |- + Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for `text-embedding-ada-002`), cannot be an empty string, and any array must be 2048 dimensions or less. + oneOf: + - type: string + default: "" + example: This is a test. + nullable: true + - type: array + minItems: 1 + maxItems: 2048 + items: + type: string + minLength: 1 + example: This is a test. + nullable: false + user: + description: A unique identifier representing your end-user, which can help monitoring and detecting abuse. + type: string + nullable: false + input_type: + description: input type of embedding search to use + type: string + example: query + encoding_format: + description: The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. + type: string + example: base64 + nullable: true + dimensions: + description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. + type: integer + example: 1 + nullable: true + required: + - input + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + properties: + object: + type: string + model: + type: string + data: + type: array + items: + type: object + properties: + index: + type: integer + object: + type: string + embedding: + type: array + items: + type: number + required: + - index + - object + - embedding + usage: + type: object + properties: + prompt_tokens: + type: integer + total_tokens: + type: integer + required: + - prompt_tokens + - total_tokens + required: + - object + - model + - data + - usage + x-ms-examples: + Create a embeddings.: + $ref: ./examples/embeddings.yaml + /deployments/{deployment-id}/chat/completions: + post: + summary: Creates a completion for the chat message + operationId: ChatCompletions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createChatCompletionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/createChatCompletionResponse" + - $ref: "#/components/schemas/createChatCompletionStreamResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + x-ms-examples: + Create a chat completion.: + $ref: ./examples/chat_completions.yaml + Creates a completion based on Azure Search data and system-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_minimum.yaml + Creates a completion based on Azure Search image vector data.: + $ref: ./examples/chat_completions_azure_search_image_vector.yaml + Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_advanced.yaml + Creates a completion for the provided Azure Cosmos DB.: + $ref: ./examples/chat_completions_cosmos_db.yaml + Creates a completion for the provided Mongo DB.: + $ref: ./examples/chat_completions_mongo_db.yaml + Creates a completion for the provided Elasticsearch.: + $ref: ./examples/chat_completions_elasticsearch.yaml + Creates a completion for the provided Pinecone resource.: + $ref: ./examples/chat_completions_pinecone.yaml + /deployments/{deployment-id}/audio/transcriptions: + post: + summary: Transcribes audio into the input language. + operationId: Transcriptions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createTranscriptionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/audioResponse" + - $ref: "#/components/schemas/audioVerboseResponse" + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio transcription with json response format.: + $ref: ./examples/audio_transcription_object.yaml + Create an audio transcription with text response format.: + $ref: ./examples/audio_transcription_text.yaml + /deployments/{deployment-id}/audio/translations: + post: + summary: Transcribes and translates input audio into English text. + operationId: Translations_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createTranslationRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/audioResponse" + - $ref: "#/components/schemas/audioVerboseResponse" + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio translation with json response format.: + $ref: ./examples/audio_translation_object.yaml + Create an audio translation with text response format.: + $ref: ./examples/audio_translation_text.yaml + /deployments/{deployment-id}/audio/speech: + post: + summary: Generates audio from the input text. + operationId: Speech_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: tts-1 + description: Deployment id of the tts model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createSpeechRequest" + responses: + "200": + description: OK + content: + application/octet-stream: + schema: + type: string + format: binary + x-ms-examples: + Create an audio from text with response format mp3.: + $ref: ./examples/audio_speech.yaml + /deployments/{deployment-id}/images/generations: + post: + summary: Generates a batch of images from a text caption on a given DALLE model deployment + operationId: ImageGenerations_Create + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/imageGenerationsRequest" + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: dalle-deployment + description: Deployment id of the dalle model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: Ok + content: + application/json: + schema: + $ref: "#/components/schemas/generateImagesResponse" + default: + description: An error occurred. + content: + application/json: + schema: + $ref: "#/components/schemas/dalleErrorResponse" + x-ms-examples: + Create an image.: + $ref: ./examples/image_generation.yaml + /assistants: + get: + operationId: List_Assistants + tags: + - Assistants + summary: Returns a list of assistants. + parameters: + - name: limit + in: query + description: &pagination_limit_param_description | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: &pagination_order_param_description | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListAssistantsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: &pagination_after_param_description | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: &pagination_before_param_description | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listAssistantsResponse" + x-ms-examples: + Create an image.: + $ref: ./examples/list_assistants.yaml + post: + operationId: Create_Assistant + tags: + - Assistants + summary: Create an assistant with a model and instructions. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createAssistantRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/create_assistant.yaml + + /assistants/{assistant_id}: + get: + operationId: Get_Assistant + tags: + - Assistants + summary: Retrieves an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/retrieve_assistant.yaml + post: + operationId: Modify_Assistant + tags: + - Assistant + summary: Modifies an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyAssistantRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/modify_assistant.yaml + delete: + operationId: Delete_Assistant + tags: + - Assistants + summary: Delete an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteAssistantResponse" + x-ms-examples: + Create an assistant.: + $ref: ./examples/delete_assistant.yaml + /threads: + post: + operationId: Create_Thread + tags: + - Assistants + summary: Create a thread. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createThreadRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Create a thread.: + $ref: ./examples/create_thread.yaml + /threads/{thread_id}: + get: + operationId: Get_Thread + tags: + - Assistants + summary: Retrieves a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Create a thread.: + $ref: ./examples/retrieve_thread.yaml + post: + operationId: Modify_Thread + tags: + - Assistants + summary: Modifies a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to modify. Only the `metadata` can be modified. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyThreadRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Modify a thread.: + $ref: ./examples/modify_thread.yaml + delete: + operationId: Delete_Thread + tags: + - Assistants + summary: Delete a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteThreadResponse" + x-ms-examples: + Delete a thread.: + $ref: ./examples/delete_thread.yaml + /threads/{thread_id}/messages: + get: + operationId: List_Messages + tags: + - Assistants + summary: Returns a list of messages for a given thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) the messages belong to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListMessagesOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - name: run_id + in: query + description: | + Filter messages by the run ID that generated them. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listMessagesResponse" + x-ms-examples: + List messages.: + $ref: ./examples/list_messages.yaml + post: + operationId: Create_Message + tags: + - Assistants + summary: Create a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to create a message for. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createMessageRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Create a message.: + $ref: ./examples/create_message.yaml + /threads/{thread_id}/messages/{message_id}: + get: + operationId: Get_Message + tags: + - Assistants + summary: Retrieve a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Retrieve a message.: + $ref: ./examples/get_message.yaml + post: + operationId: Modify_Message + tags: + - Assistants + summary: Modifies a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyMessageRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Modify a message.: + $ref: ./examples/modify_message.yaml + /threads/runs: + post: + operationId: Create_Thread_And_Run + tags: + - Assistants + summary: Create a thread and run it in one request. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createThreadAndRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Create a thread and run it.: + $ref: ./examples/create_thread_and_run.yaml + /threads/{thread_id}/runs: + get: + operationId: List_Runs + tags: + - Assistants + summary: Returns a list of runs belonging to a thread. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run belongs to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listRunsResponse" + x-ms-examples: + List runs.: + $ref: ./examples/list_runs.yaml + post: + operationId: Create_Run + tags: + - Assistants + summary: Create a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to run. + - name: include[] + in: query + description: > + A list of additional fields to include in the response. Currently + the only supported value is + `step_details.tool_calls[*].file_search.results[*].content` to fetch + the file search result content. + + schema: + type: array + items: + type: string + enum: + - step_details.tool_calls[*].file_search.results[*].content + x-ms-enum: + name: Include + modelAsString: true + values: + - value: step_details.tool_calls[*].file_search.results[*].content + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Create a run.: + $ref: ./examples/create_run.yaml + /threads/{thread_id}/runs/{run_id}: + get: + operationId: Get_Run + tags: + - Assistants + summary: Retrieves a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Retrieve a run.: + $ref: ./examples/get_run.yaml + post: + operationId: Modify_Run + tags: + - Assistants + summary: Modifies a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Modify a run.: + $ref: ./examples/modify_run.yaml + /threads/{thread_id}/runs/{run_id}/submit_tool_outputs: + post: + operationId: Submit_Tool_Outputs_To_Run + tags: + - Assistants + summary: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run that requires the tool output submission. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/submitToolOutputsRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Submit tool outputs to a run.: + $ref: ./examples/submit_tool_outputs_to_run.yaml + /threads/{thread_id}/runs/{run_id}/cancel: + post: + operationId: Cancel_Run + tags: + - Assistants + summary: Cancels a run that is `in_progress`. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Cancel a run.: + $ref: ./examples/cancel_run.yaml + /threads/{thread_id}/runs/{run_id}/steps: + get: + operationId: List_Run_Steps + tags: + - Assistants + summary: Returns a list of run steps belonging to a run. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run and run steps belong to. + - name: run_id + in: path + required: true + schema: + type: string + description: The ID of the run the run steps belong to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunStepsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + - name: include[] + in: query + description: > + A list of additional fields to include in the response. Currently + the only supported value is + `step_details.tool_calls[*].file_search.results[*].content` to fetch + the file search result content. + + schema: + type: array + items: + type: string + enum: + - step_details.tool_calls[*].file_search.results[*].content + x-ms-enum: + name: Include + modelAsString: true + values: + - value: step_details.tool_calls[*].file_search.results[*].content + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listRunStepsResponse" + x-ms-examples: + List run steps.: + $ref: ./examples/list_run_steps.yaml + /threads/{thread_id}/runs/{run_id}/steps/{step_id}: + get: + operationId: Get_Run_Step + tags: + - Assistants + summary: Retrieves a run step. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which the run and run step belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to which the run step belongs. + - in: path + name: step_id + required: true + schema: + type: string + description: The ID of the run step to retrieve. + - name: include[] + in: query + description: > + A list of additional fields to include in the response. Currently + the only supported value is + `step_details.tool_calls[*].file_search.results[*].content` to fetch + the file search result content. + + schema: + type: array + items: + type: string + enum: + - step_details.tool_calls[*].file_search.results[*].content + x-ms-enum: + name: Include + modelAsString: true + values: + - value: step_details.tool_calls[*].file_search.results[*].content + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runStepObject" + x-ms-examples: + Retrieve a run step.: + $ref: ./examples/get_run_step.yaml + /vector_stores: + get: + operationId: List_Vector_Stores + tags: + - Vector Stores + summary: Returns a list of vector stores. + parameters: + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoresOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoresResponse" + x-ms-examples: + List vector stores.: + $ref: ./examples/list_vector_stores.yaml + post: + operationId: Create_Vector_Store + tags: + - Vector Stores + summary: Create a vector store. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreRequest" + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Create a vector store.: + $ref: ./examples/create_vector_store.yaml + + /vector_stores/{vector_store_id}: + get: + operationId: Get_Vector_Store + tags: + - Vector Stores + summary: Retrieves a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Retrieve a vector store.: + $ref: ./examples/retrieve_vector_store.yaml + post: + operationId: Modify_Vector_Store + tags: + - Vector Stores + summary: Modifies a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/updateVectorStoreRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Modify a vector store.: + $ref: ./examples/modify_vector_store.yaml + + delete: + operationId: Delete_Vector_Store + tags: + - Vector Stores + summary: Delete a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteVectorStoreResponse" + x-ms-examples: + Delete a vector store.: + $ref: ./examples/delete_vector_store.yaml + + /vector_stores/{vector_store_id}/files: + get: + operationId: List_Vector_Store_Files + tags: + - Vector Stores + summary: Returns a list of vector store files. + parameters: + - name: vector_store_id + in: path + description: The ID of the vector store that the files belong to. + required: true + schema: + type: string + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoreFilesOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - name: filter + in: query + description: "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`." + schema: + type: string + enum: ["in_progress", "completed", "failed", "cancelled"] + x-ms-enum: + name: ListVectorStoreFilesFilter + modelAsString: true + values: + - value: in_progress + - value: completed + - value: failed + - value: cancelled + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoreFilesResponse" + x-ms-examples: + List vector store files.: + $ref: ./examples/list_vector_store_files.yaml + post: + operationId: Create_Vector_Store_File + tags: + - Vector Stores + summary: Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object). + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: | + The ID of the vector store for which to create a File. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreFileRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileObject" + x-ms-examples: + Create a vector store file.: + $ref: ./examples/create_vector_store_file.yaml + + /vector_stores/{vector_store_id}/files/{file_id}: + get: + operationId: Get_Vector_Store_File + tags: + - Vector Stores + summary: Retrieves a vector store file. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: The ID of the vector store that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + example: file-abc123 + description: The ID of the file being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileObject" + x-ms-examples: + Retrieve a vector store file.: + $ref: ./examples/retrieve_vector_store_file.yaml + delete: + operationId: Delete_Vector_Store_File + tags: + - Vector Stores + summary: Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + description: The ID of the file to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteVectorStoreFileResponse" + x-ms-examples: + Delete a vector store file.: + $ref: ./examples/delete_vector_store_file.yaml + + /vector_stores/{vector_store_id}/file_batches: + post: + operationId: Create_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Create a vector store file batch. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: | + The ID of the vector store for which to create a File Batch. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreFileBatchRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Create a vector store file batch.: + $ref: ./examples/create_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}: + get: + operationId: Get_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Retrieves a vector store file batch. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: The ID of the vector store that the file batch belongs to. + - in: path + name: batch_id + required: true + schema: + type: string + example: vsfb_abc123 + description: The ID of the file batch being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Retrieve a vector store file batch.: + $ref: ./examples/retrieve_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: + post: + operationId: Cancel_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store that the file batch belongs to. + - in: path + name: batch_id + required: true + schema: + type: string + description: The ID of the file batch to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Cancel a vector store file batch.: + $ref: ./examples/cancel_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}/files: + get: + operationId: List_Vector_Store_File_Batch_Files + tags: + - Vector Stores + summary: Returns a list of vector store files in a batch. + parameters: + - name: vector_store_id + in: path + description: The ID of the vector store that the files belong to. + required: true + schema: + type: string + - name: batch_id + in: path + description: The ID of the file batch that the files belong to. + required: true + schema: + type: string + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoreFilesOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - name: filter + in: query + description: "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`." + schema: + type: string + enum: ["in_progress", "completed", "failed", "cancelled"] + x-ms-enum: + name: ListVectorStoreFilesFilter + modelAsString: true + values: + - value: in_progress + - value: completed + - value: failed + - value: cancelled + - in: query + name: api-version + required: true + schema: + type: string + example: 2025-01-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoreFilesResponse" + x-ms-examples: + List vector store files in a batch.: + $ref: ./examples/list_vector_store_file_batch.yaml + +components: + schemas: + errorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/error" + errorBase: + type: object + properties: + code: + type: string + message: + type: string + error: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/innerError" + innerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + innerErrorCode: + description: Error codes for the inner error object. + enum: + - ResponsibleAIPolicyViolation + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: ResponsibleAIPolicyViolation + description: The prompt violated one of more content filter rules. + dalleErrorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/dalleError" + dalleError: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/dalleInnerError" + dalleInnerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + contentFilterCompletionTextSpan: + description: Describes a span within generated completion text. Offset 0 is the first UTF32 code point of the completion text. + type: object + properties: + completion_start_offset: + description: Offset of the UTF32 code point which begins the span. + type: integer + completion_end_offset: + description: Offset of the first UTF32 code point which is excluded from the span. This field is always equal to completion_start_offset for empty spans. This field is always larger than completion_start_offset for non-empty spans. + type: integer + required: + - completion_start_offset + - completion_end_offset + contentFilterResultBase: + type: object + properties: + filtered: + type: boolean + required: + - filtered + contentFilterSeverityResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + severity: + type: string + enum: + - safe + - low + - medium + - high + x-ms-enum: + name: ContentFilterSeverity + modelAsString: true + values: + - value: safe + description: General content or related content in generic or non-harmful contexts. + - value: low + description: Harmful content at a low intensity and risk level. + - value: medium + description: Harmful content at a medium intensity and risk level. + - value: high + description: Harmful content at a high intensity and risk level. + required: + - severity + - filtered + contentFilterDetectedResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + detected: + type: boolean + required: + - detected + - filtered + contentFilterDetectedWithCitationResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + citation: + type: object + properties: + URL: + type: string + license: + type: string + required: + - detected + - filtered + contentFilterDetectedWithCompletionTextSpansResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + details: + type: array + items: + $ref: "#/components/schemas/contentFilterCompletionTextSpan" + required: + - detected + - filtered + - details + contentFilterIdResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + id: + type: string + required: + - id + - filtered + contentFilterResultsBase: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + custom_blocklists: + $ref: "#/components/schemas/contentFilterDetailedResults" + error: + $ref: "#/components/schemas/errorBase" + contentFilterPromptResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + indirect_attack: + $ref: "#/components/schemas/contentFilterDetectedResult" + contentFilterChoiceResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + protected_material_text: + $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + protected_material_code: + $ref: "#/components/schemas/contentFilterDetectedWithCitationResult" + - properties: + ungrounded_material: + $ref: "#/components/schemas/contentFilterDetectedWithCompletionTextSpansResult" + contentFilterDetailedResults: + type: object + description: Content filtering results with a detail of content filter ids for the filtered segments. + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + details: + items: + $ref: "#/components/schemas/contentFilterIdResult" + type: array + required: + - filtered + - details + promptFilterResult: + type: object + description: Content filtering results for a single prompt in the request. + properties: + prompt_index: + type: integer + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + promptFilterResults: + type: array + description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. + items: + $ref: "#/components/schemas/promptFilterResult" + dalleContentFilterResults: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + dalleFilterResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/dalleContentFilterResults" + - properties: + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + custom_blocklists: + $ref: "#/components/schemas/contentFilterDetailedResults" + chatCompletionsRequestCommon: + type: object + properties: + temperature: + description: |- + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + We generally recommend altering this or `top_p` but not both. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + description: |- + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + We generally recommend altering this or `temperature` but not both. + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + stream: + description: "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message." + type: boolean + nullable: true + default: false + stop: + description: Up to 4 sequences where the API will stop generating further tokens. + oneOf: + - type: string + nullable: true + - type: array + items: + type: string + nullable: false + minItems: 1 + maxItems: 4 + description: Array minimum size of 1 and maximum of 4 + default: null + max_tokens: + description: | + The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). + + This is not compatible with o1 series models. + type: integer + default: 4096 + max_completion_tokens: + description: | + An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. This is only supported in o1 series models. Will expand the support to other models in future API release. + + type: integer + nullable: true + presence_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + type: number + default: 0 + minimum: -2 + maximum: 2 + frequency_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + type: number + default: 0 + minimum: -2 + maximum: 2 + logit_bias: + description: Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + type: object + nullable: true + store: + type: boolean + default: false + nullable: true + description: Whether or not to store the output of this chat completion request for use in our model distillation or evaluation products. + metadata: + type: object + nullable: true + description: Developer-defined tags and values used for filtering completions in the stored completions dashboard. + additionalProperties: + type: string + user: + description: A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse. + type: string + example: user-1234 + nullable: false + createCompletionRequest: + type: object + properties: + prompt: + description: &completions_prompt_description | + The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays. + + Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. + default: "<|endoftext|>" + nullable: true + oneOf: + - type: string + default: "" + example: "This is a test." + - type: array + items: + type: string + default: "" + example: "This is a test." + best_of: + type: integer + default: 1 + minimum: 0 + maximum: 20 + nullable: true + description: &completions_best_of_description | + Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. + + When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + echo: + type: boolean + default: false + nullable: true + description: &completions_echo_description > + Echo back the prompt in addition to the completion + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_frequency_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + logit_bias: &completions_logit_bias + type: object + x-oaiTypeLabel: map + default: null + nullable: true + additionalProperties: + type: integer + description: &completions_logit_bias_description | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + + As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated. + logprobs: &completions_logprobs_configuration + type: integer + minimum: 0 + maximum: 5 + default: null + nullable: true + description: &completions_logprobs_description | + Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. + + The maximum value for `logprobs` is 5. + max_tokens: + type: integer + minimum: 0 + default: 16 + example: 16 + nullable: true + description: &completions_max_tokens_description | + The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion. + + The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: &completions_completions_description | + How many completions to generate for each prompt. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_presence_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + seed: &completions_seed_param + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: &completions_stop_description > + Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. + default: null + nullable: true + oneOf: + - type: string + default: <|endoftext|> + example: "\n" + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + example: '["\n"]' + stream: + description: > + Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + suffix: + description: | + The suffix that comes after a completion of inserted text. + + This parameter is only supported for `gpt-3.5-turbo-instruct`. + default: null + nullable: true + type: string + example: "test." + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: &completions_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + + We generally recommend altering this or `top_p` but not both. + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &completions_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or `temperature` but not both. + user: &end_user_param_configuration + type: string + example: user-1234 + description: | + A unique identifier representing your end-user, which can help to monitor and detect abuse. + required: + - prompt + + createCompletionResponse: + type: object + description: | + Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). + properties: + id: + type: string + description: A unique identifier for the completion. + choices: + type: array + description: The list of completion choices the model generated for the input prompt. + items: + type: object + required: + - finish_reason + - index + - logprobs + - text + properties: + finish_reason: + type: string + description: &completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + or `content_filter` if content was omitted due to a flag from our content filters. + enum: ["stop", "length", "content_filter"] + index: + type: integer + logprobs: + type: object + nullable: true + properties: + text_offset: + type: array + items: + type: integer + token_logprobs: + type: array + items: + type: number + tokens: + type: array + items: + type: string + top_logprobs: + type: array + items: + type: object + additionalProperties: + type: number + text: + type: string + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + created: + type: integer + description: The Unix timestamp (in seconds) of when the completion was created. + model: + type: string + description: The model used for completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always "text_completion" + enum: [text_completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - id + - object + - created + - model + - choices + + createChatCompletionRequest: + type: object + allOf: + - $ref: "#/components/schemas/chatCompletionsRequestCommon" + - properties: + messages: + description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). + type: array + minItems: 1 + items: + $ref: "#/components/schemas/chatCompletionRequestMessage" + data_sources: + type: array + description: |2- + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + items: + $ref: "#/components/schemas/azureChatExtensionConfiguration" + reasoning_effort: + type: string + enum: + - low + - medium + - high + default: medium + description: > + **o1 models only** + + + Constrains effort on reasoning for + + [reasoning + models](https://platform.openai.com/docs/guides/reasoning). + + Currently supported values are `low`, `medium`, and `high`. Reducing + + reasoning effort can result in faster responses and fewer tokens + used + + on reasoning in a response. + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_frequency_penalty_description + logit_bias: + type: object + default: null + nullable: true + additionalProperties: + type: integer + description: | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + logprobs: + description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. + type: boolean + default: false + nullable: true + top_logprobs: + description: An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + type: integer + minimum: 0 + maximum: 20 + nullable: true + max_tokens: + description: | + The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. + + The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + type: integer + nullable: true + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. + modalities: + $ref: "#/components/schemas/ChatCompletionModalities" + prediction: + nullable: true + x-oaiExpandable: true + description: > + Configuration for a [Predicted + Output](/docs/guides/predicted-outputs), + + which can greatly improve response times when large parts of the + model + + response are known ahead of time. This is most common when you are + + regenerating a file with only minor changes to most of the content. + oneOf: + - $ref: "#/components/schemas/PredictionContent" + audio: + type: object + description: > + Parameters for audio output. Required when audio output is requested + with `modalities: ["audio"]`. [Learn more](/docs/guides/audio). + required: + - voice + - format + x-oaiExpandable: true + properties: + voice: + type: string + enum: + - alloy + - echo + - fable + - onyx + - nova + - shimmer + description: | + Specifies the voice type. Supported voices are `alloy`, `echo`, + `fable`, `onyx`, `nova`, and `shimmer`. + format: + type: string + enum: + - wav + - mp3 + - flac + - opus + - pcm16 + description: > + Specifies the output audio format. Must be one of `wav`, `mp3`, + `flac`, + `opus`, or `pcm16`. + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_presence_penalty_description + response_format: + description: | + An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema. + + Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + + **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. + oneOf: + - $ref: "#/components/schemas/ResponseFormatText" + - $ref: "#/components/schemas/ResponseFormatJsonObject" + - $ref: "#/components/schemas/ResponseFormatJsonSchema" + x-oaiExpandable: true + seed: + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + This feature is in Beta. + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: | + Up to 4 sequences where the API will stop generating further tokens. + default: null + oneOf: + - type: string + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + stream: + description: > + If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *completions_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *completions_top_p_description + tools: + type: array + description: > + A list of tools the model may call. Currently, only functions are supported as a tool. + Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. + items: + $ref: "#/components/schemas/chatCompletionTool" + tool_choice: + $ref: "#/components/schemas/chatCompletionToolChoiceOption" + function_call: + deprecated: true + description: | + Deprecated in favor of `tool_choice`. + + Controls which (if any) function is called by the model. + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + + `none` is the default when no functions are present. `auto` is the default if functions are present. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + - $ref: "#/components/schemas/chatCompletionFunctionCallOption" + x-oaiExpandable: true + functions: + deprecated: true + description: | + Deprecated in favor of `tools`. + + A list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + maxItems: 128 + items: + $ref: "#/components/schemas/chatCompletionFunctions" + user: *end_user_param_configuration + user_security_context: + $ref: "#/components/schemas/user_security_context" + + required: + - messages + + user_security_context: + description: | + User security context contains several parameters that describe the AI application itself, and the end user that interacts with the AI application. These fields assist your security operations teams to investigate and mitigate security incidents by providing a comprehensive approach to protecting your AI applications. [Learn more](https://aka.ms/TP4AI/Documentation/EndUserContext) about protecting AI applications using Microsoft Defender for Cloud. + type: object + properties: + application_name: + type: string + description: The name of the application. Sensitive personal information should not be included in this field. + end_user_id: + type: string + format: uuid + description: This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application. Sensitive personal information should not be included in this field. + end_user_tenant_id: + type: string + format: uuid + description: The Microsoft 365 tenant ID the end user belongs to. It's required when the generative AI application is multi tenant. + source_ip: + type: string + description: Captures the original client's IP address, accepting both IPv4 and IPv6 formats. + + chatCompletionFunctions: + type: object + deprecated: true + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + required: + - name + + chatCompletionFunctionCallOption: + type: object + description: > + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + properties: + name: + type: string + description: The name of the function to call. + required: + - name + + chatCompletionFunctionParameters: + type: object + description: The parameters the functions accepts, described as a JSON Schema object. See the [guide/](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + additionalProperties: true + + chatCompletionRequestMessage: + oneOf: + - $ref: "#/components/schemas/ChatCompletionRequestDeveloperMessage" + - $ref: "#/components/schemas/chatCompletionRequestSystemMessage" + - $ref: "#/components/schemas/chatCompletionRequestUserMessage" + - $ref: "#/components/schemas/chatCompletionRequestAssistantMessage" + - $ref: "#/components/schemas/chatCompletionRequestToolMessage" + - $ref: "#/components/schemas/chatCompletionRequestFunctionMessage" + + ChatCompletionRequestDeveloperMessage: + type: object + title: Developer message + description: > + Developer-provided instructions that the model should follow, regardless + of + + messages sent by the user. With o1 models and newer, `developer` + messages + + replace the previous `system` messages. + properties: + content: + description: The contents of the developer message. + oneOf: + - type: string + description: The contents of the developer message. + title: Text content + - type: array + description: An array of content parts with a defined type. For developer + messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestDeveloperMessageContentPart" + minItems: 1 + role: + type: string + enum: + - developer + description: The role of the messages author, in this case `developer`. + name: + type: string + description: An optional name for the participant. Provides the model + information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestSystemMessage: + type: object + title: System message + properties: + content: + description: The contents of the system message. + oneOf: + - type: string + description: The contents of the system message. + title: Text content + - type: array + description: An array of content parts with a defined type. For system messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + minItems: 1 + role: + type: string + enum: ["system"] + description: The role of the messages author, in this case `system`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestUserMessage: + type: object + title: User message + properties: + content: + description: | + The contents of the user message. + oneOf: + - type: string + description: The text contents of the message. + title: Text content + - type: array + description: An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestUserMessageContentPart" + minItems: 1 + x-oaiExpandable: true + role: + type: string + enum: ["user"] + description: The role of the messages author, in this case `user`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestAssistantMessage: + type: object + title: Assistant message + properties: + content: + nullable: true + oneOf: + - type: string + description: The contents of the assistant message. + title: Text content + - type: array + description: An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + minItems: 1 + description: | + The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. + refusal: + nullable: true + type: string + description: The refusal message by the assistant. + role: + type: string + enum: ["assistant"] + description: The role of the messages author, in this case `assistant`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + tool_calls: + $ref: "#/components/schemas/chatCompletionMessageToolCalls" + function_call: + type: object + deprecated: true + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + nullable: true + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + required: + - arguments + - name + required: + - role + + chatCompletionRequestToolMessage: + type: object + title: Tool message + properties: + role: + type: string + enum: ["tool"] + description: The role of the messages author, in this case `tool`. + content: + oneOf: + - type: string + description: The contents of the tool message. + title: Text content + - type: array + description: An array of content parts with a defined type. For tool messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestToolMessageContentPart" + minItems: 1 + description: The contents of the tool message. + tool_call_id: + type: string + description: Tool call that this message is responding to. + required: + - role + - content + - tool_call_id + + chatCompletionRequestFunctionMessage: + type: object + title: Function message + deprecated: true + properties: + role: + type: string + enum: ["function"] + description: The role of the messages author, in this case `function`. + content: + nullable: true + type: string + description: The contents of the function message. + name: + type: string + description: The name of the function to call. + required: + - role + - content + - name + + chatCompletionRequestDeveloperMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestSystemMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestUserMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartImage" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartAudio" + + chatCompletionRequestAssistantMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + + chatCompletionRequestToolMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestMessageContentPartText: + type: object + title: Text content part + properties: + type: + type: string + enum: ["text"] + description: The type of the content part. + text: + type: string + description: The text content. + required: + - type + - text + + chatCompletionRequestMessageContentPartAudio: + type: object + title: Audio content part + description: | + Learn about [audio inputs](/docs/guides/audio). + properties: + type: + type: string + enum: + - input_audio + description: The type of the content part. Always `input_audio`. + input_audio: + type: object + properties: + data: + type: string + description: Base64 encoded audio data. + format: + type: string + enum: + - wav + - mp3 + description: > + The format of the encoded audio data. Currently supports "wav" + and "mp3". + required: + - data + - format + required: + - type + - input_audio + + chatCompletionRequestMessageContentPartImage: + type: object + title: Image content part + properties: + type: + type: string + enum: ["image_url"] + description: The type of the content part. + image_url: + type: object + properties: + url: + type: string + description: Either a URL of the image or the base64 encoded image data. + format: uri + detail: + type: string + description: Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto). + enum: ["auto", "low", "high"] + default: "auto" + required: + - url + required: + - type + - image_url + + chatCompletionRequestMessageContentPartRefusal: + type: object + title: Refusal content part + properties: + type: + type: string + enum: ["refusal"] + description: The type of the content part. + refusal: + type: string + description: The refusal message generated by the model. + required: + - type + - refusal + azureChatExtensionConfiguration: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/azureChatExtensionType" + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + discriminator: + propertyName: type + mapping: + azure_search: "#/components/schemas/azureSearchChatExtensionConfiguration" + azure_cosmos_db: "#/components/schemas/azureCosmosDBChatExtensionConfiguration" + elasticsearch: "#/components/schemas/elasticsearchChatExtensionConfiguration" + mongo_db: "#/components/schemas/mongoDBChatExtensionConfiguration" + pinecone: "#/components/schemas/pineconeChatExtensionConfiguration" + azureChatExtensionType: + type: string + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + enum: + - azure_search + - azure_cosmos_db + - elasticsearch + - mongo_db + - pinecone + x-ms-enum: + name: AzureChatExtensionType + modelAsString: true + values: + - name: azureSearch + value: azure_search + description: Represents the use of Azure Search as an Azure OpenAI chat extension. + - name: azureCosmosDB + value: azure_cosmos_db + description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. + - name: elasticsearch + value: elasticsearch + description: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. + - name: mongoDB + value: mongo_db + description: Represents the use of Mongo DB as an Azure OpenAI chat extension. + - name: pinecone + value: pinecone + description: Represents the use of Pinecone index as an Azure OpenAI chat extension. + azureSearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureSearchChatExtensionParameters" + x-ms-discriminator-value: azure_search + azureSearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The absolute endpoint path for the Azure Search resource to use. + format: uri + index_name: + type: string + description: The name of the index to use as available in the referenced Azure Search resource. + fields_mapping: + $ref: "#/components/schemas/azureSearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/azureSearchQueryType" + semantic_configuration: + type: string + description: The additional semantic configuration for the query. + filter: + type: string + description: Search filter. + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + - $ref: "#/components/schemas/onYourDataIntegratedVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: Parameters for Azure Search when used as an Azure OpenAI chat extension. + azureSearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + image_vector_fields: + type: array + description: The names of fields that represent image vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Search resource. + azureSearchQueryType: + type: string + description: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - semantic + - vector + - vector_simple_hybrid + - vector_semantic_hybrid + x-ms-enum: + name: AzureSearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: semantic + value: semantic + description: Represents the semantic query parser for advanced semantic modeling. + - name: vector + value: vector + description: Represents vector search over computed data. + - name: vectorSimpleHybrid + value: vector_simple_hybrid + description: Represents a combination of the simple query strategy with vector data. + - name: vectorSemanticHybrid + value: vector_semantic_hybrid + description: Represents a combination of semantic search and vector data querying. + azureCosmosDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureCosmosDBChatExtensionParameters" + x-ms-discriminator-value: azure_cosmos_db + azureCosmosDBChatExtensionParameters: + required: + - authentication + - container_name + - database_name + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + database_name: + type: string + description: The MongoDB vCore database name to use with Azure Cosmos DB. + container_name: + type: string + description: The name of the Azure Cosmos DB resource container. + index_name: + type: string + description: The MongoDB vCore index name to use with Azure Cosmos DB. + fields_mapping: + $ref: "#/components/schemas/azureCosmosDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. + azureCosmosDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource. + elasticsearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/elasticsearchChatExtensionParameters" + x-ms-discriminator-value: elasticsearch + elasticsearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The endpoint of Elasticsearch®. + format: uri + index_name: + type: string + description: The index name of Elasticsearch®. + fields_mapping: + $ref: "#/components/schemas/elasticsearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/elasticsearchQueryType" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + - $ref: "#/components/schemas/onYourDataModelIdVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + elasticsearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Elasticsearch® resource. + elasticsearchQueryType: + type: string + description: The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - vector + x-ms-enum: + name: ElasticsearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: vector + value: vector + description: Represents vector search over computed data. + mongoDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Mongo DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/mongoDBChatExtensionParameters" + x-ms-discriminator-value: mongo_db + mongoDBChatExtensionParameters: + required: + - authentication + - app_name + - collection_name + - database_name + - endpoint + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The name of the Mongo DB cluster endpoint. + database_name: + type: string + description: The name of the Mongo DB database. + collection_name: + type: string + description: The name of the Mongo DB Collection. + app_name: + type: string + description: The name of the Mongo DB Application. + index_name: + type: string + description: The The name of the Mongo DB index. + fields_mapping: + $ref: "#/components/schemas/mongoDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Mongo DB. + + mongoDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Mongo DB resource. + + pineconeChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/pineconeChatExtensionParameters" + x-ms-discriminator-value: pinecone + pineconeChatExtensionParameters: + required: + - authentication + - embedding_dependency + - environment + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + environment: + type: string + description: The environment name of Pinecone. + index_name: + type: string + description: The name of the Pinecone database index. + fields_mapping: + $ref: "#/components/schemas/pineconeFieldMappingOptions" + embedding_dependency: + $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: Parameters for configuring Azure OpenAI Pinecone chat extensions. + pineconeFieldMappingOptions: + required: + - content_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + description: Optional settings to control how fields are processed when using a configured Pinecone resource. + onYourDataAuthenticationOptions: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataAuthenticationType" + description: The authentication options for Azure OpenAI On Your Data. + discriminator: + propertyName: type + mapping: + api_key: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + connection_string: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + key_and_key_id: "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + encoded_api_key: "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + access_token: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + system_assigned_managed_identity: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + user_assigned_managed_identity: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + username_and_password: "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + onYourDataContextProperty: + type: string + description: The context property. + enum: + - citations + - intent + - all_retrieved_documents + x-ms-enum: + name: OnYourDataContextProperty + modelAsString: true + values: + - name: citations + value: citations + description: The `citations` property. + - name: intent + value: intent + description: The `intent` property. + - name: allRetrievedDocuments + value: all_retrieved_documents + description: The `all_retrieved_documents` property. + onYourDataAuthenticationType: + type: string + description: The authentication types supported with Azure OpenAI On Your Data. + enum: + - api_key + - connection_string + - key_and_key_id + - encoded_api_key + - access_token + - system_assigned_managed_identity + - user_assigned_managed_identity + - username_and_password + x-ms-enum: + name: OnYourDataAuthenticationType + modelAsString: true + values: + - name: apiKey + value: api_key + description: Authentication via API key. + - name: connectionString + value: connection_string + description: Authentication via connection string. + - name: keyAndKeyId + value: key_and_key_id + description: Authentication via key and key ID pair. + - name: encodedApiKey + value: encoded_api_key + description: Authentication via encoded API key. + - name: accessToken + value: access_token + description: Authentication via access token. + - name: systemAssignedManagedIdentity + value: system_assigned_managed_identity + description: Authentication via system-assigned managed identity. + - name: userAssignedManagedIdentity + value: user_assigned_managed_identity + description: Authentication via user-assigned managed identity. + - name: usernameAndPassword + value: username_and_password + description: Authentication via username and password. + onYourDataApiKeyAuthenticationOptions: + required: + - key + description: The authentication options for Azure OpenAI On Your Data when using an API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The API key to use for authentication. + x-ms-discriminator-value: api_key + onYourDataConnectionStringAuthenticationOptions: + required: + - connection_string + description: The authentication options for Azure OpenAI On Your Data when using a connection string. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + connection_string: + type: string + description: The connection string to use for authentication. + x-ms-discriminator-value: connection_string + onYourDataKeyAndKeyIdAuthenticationOptions: + required: + - key + - key_id + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The Elasticsearch key to use for authentication. + key_id: + type: string + description: The Elasticsearch key ID to use for authentication. + x-ms-discriminator-value: key_and_key_id + onYourDataEncodedApiKeyAuthenticationOptions: + required: + - encoded_api_key + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + encoded_api_key: + type: string + description: The Elasticsearch encoded API key to use for authentication. + x-ms-discriminator-value: encoded_api_key + onYourDataAccessTokenAuthenticationOptions: + required: + - access_token + description: The authentication options for Azure OpenAI On Your Data when using access token. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + access_token: + type: string + description: The access token to use for authentication. + x-ms-discriminator-value: access_token + onYourDataSystemAssignedManagedIdentityAuthenticationOptions: + description: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + x-ms-discriminator-value: system_assigned_managed_identity + onYourDataUserAssignedManagedIdentityAuthenticationOptions: + required: + - managed_identity_resource_id + description: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + managed_identity_resource_id: + type: string + description: The resource ID of the user-assigned managed identity to use for authentication. + x-ms-discriminator-value: user_assigned_managed_identity + onYourDataUsernameAndPasswordAuthenticationOptions: + required: + - username + - password + description: The authentication options for Azure OpenAI On Your Data when using a username and a password. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + username: + type: string + description: The username to use for authentication. + password: + type: string + description: The password. to use for authentication. + x-ms-discriminator-value: username_and_password + onYourDataVectorizationSource: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataVectorizationSourceType" + description: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. + discriminator: + propertyName: type + mapping: + endpoint: "#/components/schemas/onYourDataEndpointVectorizationSource" + deployment_name: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + integrated: "#/components/schemas/onYourDataIntegratedVectorizationSource" + model_id: "#/components/schemas/onYourDataModelIdVectorizationSource" + onYourDataVectorizationSourceType: + type: string + description: |- + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + enum: + - endpoint + - deployment_name + - integrated + - model_id + x-ms-enum: + name: OnYourDataVectorizationSourceType + modelAsString: true + values: + - name: endpoint + value: endpoint + description: Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + - name: deploymentName + value: deployment_name + description: |- + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + - name: integrated + value: integrated + description: Represents the integrated vectorizer defined within the search resource. + - name: modelId + value: model_id + description: |- + Represents a specific embedding model ID as defined in the search service. + Currently only supported by Elasticsearch®. + onYourDataEndpointVectorizationSource: + required: + - authentication + - endpoint + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + endpoint: + type: string + description: Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed. + format: uri + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + dimensions: + type: integer + description: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. + format: int32 + x-ms-discriminator-value: endpoint + onYourDataDeploymentNameVectorizationSource: + required: + - deployment_name + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + deployment_name: + type: string + description: Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks. + dimensions: + type: integer + description: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. + format: int32 + x-ms-discriminator-value: deployment_name + onYourDataIntegratedVectorizationSource: + description: |- + Represents the integrated vectorizer defined within the search resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + x-ms-discriminator-value: integrated + onYourDataModelIdVectorizationSource: + required: + - model_id + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a search service model ID. Currently only supported by Elasticsearch®. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + model_id: + type: string + description: Specifies the model ID to use for vectorization. This model ID must be defined in the search service. + x-ms-discriminator-value: model_id + azureChatExtensionsMessageContext: + type: object + properties: + citations: + type: array + description: The data source retrieval result, used to generate the assistant message in the response. + items: + $ref: "#/components/schemas/citation" + x-ms-identifiers: [] + intent: + type: string + description: The detected intent from the chat history, used to pass to the next turn to carry over the context. + all_retrieved_documents: + type: array + description: All the retrieved documents. + items: + $ref: "#/components/schemas/retrievedDocument" + + description: |2- + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + citation: + required: + - content + type: object + properties: + content: + type: string + description: The content of the citation. + title: + type: string + description: The title of the citation. + url: + type: string + description: The URL of the citation. + filepath: + type: string + description: The file path of the citation. + chunk_id: + type: string + description: The chunk ID of the citation. + rerank_score: + type: number + description: The rerank score of the retrieved document. + format: double + description: citation information for a chat completions response message. + retrievedDocument: + type: object + description: The retrieved document. + required: + - search_queries + - data_source_index + allOf: + - $ref: "#/components/schemas/citation" + - properties: + search_queries: + type: array + description: The search queries used to retrieve the document. + items: + type: string + data_source_index: + type: integer + description: The index of the data source. + format: int32 + original_search_score: + type: number + description: The original search score of the retrieved document. + format: double + filter_reason: + $ref: "#/components/schemas/filterReason" + description: Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset. + + filterReason: + type: string + description: The filtering reason of the retrieved document. + enum: + - score + - rerank + x-ms-enum: + name: FilterReason + modelAsString: true + values: + - name: score + value: score + description: The document is filtered by original search score threshold defined by `strictness` configure. + - name: rerank + value: rerank + description: The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure. + + chatCompletionMessageToolCall: + type: object + properties: + id: + type: string + description: The ID of the tool call. + type: + $ref: "#/components/schemas/toolCallType" + function: + type: object + description: The function that the model called. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + required: + - id + - type + - function + toolCallType: + type: string + enum: + - function + description: The type of the tool call, in this case `function`. + x-ms-enum: + name: ToolCallType + modelAsString: true + values: + - value: function + description: The tool call type is function. + chatCompletionRequestMessageTool: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + nullable: true + properties: + tool_call_id: + type: string + description: Tool call that this message is responding to. + content: + type: string + description: The contents of the message. + nullable: true + required: + - tool_call_id + - content + chatCompletionRequestMessageFunction: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + description: Deprecated. Message that represents a function. + nullable: true + properties: + role: + type: string + enum: + - function + description: The role of the messages author, in this case `function`. + name: + type: string + description: The contents of the message. + content: + type: string + description: The contents of the message. + nullable: true + required: + - function_call_id + - content + createChatCompletionResponse: + type: object + description: Represents a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + choices: + type: array + description: A list of chat completion choices. Can be more than one if `n` is greater than 1. + items: + type: object + required: + - finish_reason + - index + - message + - logprobs + properties: + finish_reason: + type: string + description: &chat_completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + `content_filter` if content was omitted due to a flag from our content filters, + `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + index: + type: integer + description: The index of the choice in the list of choices. + message: + $ref: "#/components/schemas/chatCompletionResponseMessage" + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + logprobs: &chat_completion_response_logprobs + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + - refusal + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. + model: + type: string + description: The model used for the chat completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion`. + enum: [chat.completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - choices + - created + - id + - model + - object + + createChatCompletionStreamResponse: + type: object + description: Represents a streamed chunk of a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. Each chunk has the same ID. + choices: + type: array + description: | + A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. + items: + type: object + required: + - delta + - finish_reason + - index + properties: + delta: + $ref: "#/components/schemas/chatCompletionStreamResponseDelta" + logprobs: *chat_completion_response_logprobs + finish_reason: + type: string + description: *chat_completion_finish_reason_description + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + nullable: true + index: + type: integer + description: The index of the choice in the list of choices. + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. + model: + type: string + description: The model to generate the completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion.chunk`. + enum: [chat.completion.chunk] + required: + - prompt_tokens + - completion_tokens + - total_tokens + required: + - choices + - created + - id + - model + - object + + chatCompletionStreamResponseDelta: + type: object + description: A chat completion delta generated by streamed model responses. + properties: + content: + type: string + description: The contents of the chunk message. + nullable: true + function_call: + deprecated: true + type: object + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + tool_calls: + type: array + items: + $ref: "#/components/schemas/chatCompletionMessageToolCallChunk" + role: + type: string + enum: ["system", "user", "assistant", "tool"] + description: The role of the author of this message. + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + + chatCompletionMessageToolCallChunk: + type: object + properties: + index: + type: integer + id: + type: string + description: The ID of the tool call. + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - index + + chatCompletionStreamOptions: + description: | + Options for streaming response. Only set this when you set `stream: true`. + type: object + nullable: true + default: null + properties: + include_usage: + type: boolean + description: | + If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. + + chatCompletionChoiceLogProbs: + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + chatCompletionTokenLogprob: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + top_logprobs: + description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. + type: array + items: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + required: + - token + - logprob + - bytes + required: + - token + - logprob + - bytes + - top_logprobs + + chatCompletionResponseMessage: + type: object + description: A chat completion message generated by the model. + properties: + role: + $ref: "#/components/schemas/chatCompletionResponseMessageRole" + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + function_call: + $ref: "#/components/schemas/chatCompletionFunctionCall" + audio: + type: object + description: > + If the audio output modality is requested, this object contains data about the audio response from the model. [Learn more](/docs/guides/audio). + x-oaiExpandable: true + required: + - id + - expires_at + - data + - transcript + properties: + id: + type: string + description: Unique identifier for this audio response. + expires_at: + type: integer + description: > + The Unix timestamp (in seconds) for when this audio response + will no longer be accessible on the server for use in multi-turn + conversations. + data: + type: string + description: | + Base64 encoded audio bytes generated by the model, in the format + specified in the request. + transcript: + type: string + description: Transcript of the audio generated by the model. + context: + $ref: "#/components/schemas/azureChatExtensionsMessageContext" + required: + - role + - content + - refusal + chatCompletionResponseMessageRole: + type: string + enum: + - assistant + description: The role of the author of the response message. + chatCompletionToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + `none` is the default when no tools are present. `auto` is the default if tools are present. + oneOf: + - type: string + description: > + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + enum: + - none + - auto + - required + - $ref: "#/components/schemas/chatCompletionNamedToolChoice" + chatCompletionNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific function. + properties: + type: + type: string + enum: + - "function" + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + - function + + ParallelToolCalls: + description: Whether to enable parallel function calling during tool use. + type: boolean + default: true + + PredictionContent: + type: object + title: Static Content + description: > + Static predicted output content, such as the content of a text file that + is + + being regenerated. + required: + - type + - content + properties: + type: + type: string + enum: + - content + description: | + The type of the predicted content you want to provide. This type is + currently always `content`. + content: + x-oaiExpandable: true + description: > + The content that should be matched when generating a model response. + + If generated tokens would match this content, the entire model + response + + can be returned much more quickly. + oneOf: + - type: string + title: Text content + description: | + The content used for a Predicted Output. This is often the + text of a file you are regenerating with minor changes. + - type: array + description: An array of content parts with a defined type. Supported options + differ based on the [model](/docs/models) being used to generate + the response. Can contain text inputs. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + minItems: 1 + + chatCompletionMessageToolCalls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + + ChatCompletionModalities: + type: array + description: > + Output types that you would like the model to generate for this request. + Most models are capable of generating text, which is the default: + `["text"]` + The `gpt-4o-audio-preview` model can also be used to [generate + audio](/docs/guides/audio). To + request that this model generate both text and audio responses, you can + use: + `["text", "audio"]` + items: + type: string + enum: + - text + - audio + + chatCompletionFunctionCall: + type: object + description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + completionUsage: + type: object + description: Usage statistics for the completion request. + properties: + prompt_tokens: + type: integer + description: Number of tokens in the prompt. + completion_tokens: + type: integer + description: Number of tokens in the generated completion. + total_tokens: + type: integer + description: Total number of tokens used in the request (prompt + completion). + prompt_tokens_details: + type: object + description: Details of the prompt tokens. + properties: + audio_tokens: + type: integer + description: Audio input tokens present in the prompt. + cached_tokens: + type: integer + description: Cached tokens present in the prompt. + completion_tokens_details: + type: object + description: Breakdown of tokens used in a completion. + properties: + accepted_prediction_tokens: + type: integer + description: | + When using Predicted Outputs, the number of tokens in the + prediction that appeared in the completion. + audio_tokens: + type: integer + description: Audio input tokens generated by the model. + reasoning_tokens: + type: integer + description: Tokens generated by the model for reasoning. + rejected_prediction_tokens: + type: integer + description: > + When using Predicted Outputs, the number of tokens in the + + prediction that did not appear in the completion. However, like + + reasoning tokens, these tokens are still counted in the total + + completion tokens for purposes of billing, output, and context + window + + limits. + required: + - prompt_tokens + - completion_tokens + - total_tokens + chatCompletionTool: + type: object + properties: + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + $ref: "#/components/schemas/FunctionObject" + required: + - type + - function + + FunctionParameters: + type: object + description: "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." + additionalProperties: true + + FunctionObject: + type: object + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling). + required: + - name + + ResponseFormatText: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `text`" + enum: + - text + required: + - type + + ResponseFormatJsonObject: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_object`" + enum: + - json_object + required: + - type + + ResponseFormatJsonSchemaSchema: + type: object + description: "The schema for the response format, described as a JSON Schema object." + additionalProperties: true + + ResponseFormatJsonSchema: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_schema`" + enum: + - json_schema + json_schema: + type: object + properties: + description: + type: string + description: A description of what the response format is for, used by the model to determine how to respond in the format. + name: + type: string + description: The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + schema: + $ref: "#/components/schemas/ResponseFormatJsonSchemaSchema" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. + required: + - schema + - name + required: + - type + - json_schema + + chatCompletionChoiceCommon: + type: object + properties: + index: + type: integer + finish_reason: + type: string + createTranslationRequest: + type: object + description: Translation request. + properties: + file: + type: string + description: The audio file to translate. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + required: + - file + audioResponse: + description: Translation or transcription response when response_format was json + type: object + properties: + text: + type: string + description: Translated or transcribed text. + required: + - text + audioVerboseResponse: + description: Translation or transcription response when response_format was verbose_json + type: object + allOf: + - $ref: "#/components/schemas/audioResponse" + - properties: + task: + type: string + description: Type of audio task. + enum: + - transcribe + - translate + x-ms-enum: + modelAsString: true + language: + type: string + description: Language. + duration: + type: number + description: Duration. + segments: + type: array + items: + $ref: "#/components/schemas/audioSegment" + words: + type: array + items: + $ref: "#/components/schemas/audioWord" + + required: + - text + audioResponseFormat: + title: AudioResponseFormat + description: Defines the format of the output. + enum: + - json + - text + - srt + - verbose_json + - vtt + type: string + x-ms-enum: + modelAsString: true + createTranscriptionRequest: + type: object + description: Transcription request. + properties: + file: + type: string + description: The audio file object to transcribe. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + language: + type: string + description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. + timestamp_granularities[]: + description: | + The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. + type: array + items: + type: string + enum: + - word + - segment + default: [segment] + required: + - file + audioSegment: + type: object + description: Transcription or translation segment. + properties: + id: + type: integer + description: Segment identifier. + seek: + type: number + description: Offset of the segment. + start: + type: number + description: Segment start offset. + end: + type: number + description: Segment end offset. + text: + type: string + description: Segment text. + tokens: + type: array + items: + type: number + nullable: false + description: Tokens of the text. + temperature: + type: number + description: Temperature. + avg_logprob: + type: number + description: Average log probability. + compression_ratio: + type: number + description: Compression ratio. + no_speech_prob: + type: number + description: Probability of 'no speech'. + audioWord: + type: object + description: Transcription or translation word. + properties: + word: + type: string + description: Word + start: + type: number + description: Word start offset. + end: + type: number + description: Word end offset. + createSpeechRequest: + type: object + description: Speech request. + properties: + input: + type: string + description: The text to synthesize audio for. The maximum length is 4096 characters. + maxLength: 4096 + voice: + type: string + description: The voice to use for speech synthesis. + enum: + - alloy + - echo + - fable + - onyx + - nova + - shimmer + response_format: + type: string + description: The format to synthesize the audio in. + enum: + - mp3 + - opus + - aac + - flac + - wav + - pcm + speed: + description: The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default. + type: number + default: 1 + minimum: 0.25 + maximum: 4 + required: + - input + - voice + imageQuality: + description: The quality of the image that will be generated. + type: string + enum: + - standard + - hd + default: standard + x-ms-enum: + name: Quality + modelAsString: true + values: + - value: standard + description: Standard quality creates images with standard quality. + name: Standard + - value: hd + description: HD quality creates images with finer details and greater consistency across the image. + name: HD + imagesResponseFormat: + description: The format in which the generated images are returned. + type: string + enum: + - url + - b64_json + default: url + x-ms-enum: + name: ImagesResponseFormat + modelAsString: true + values: + - value: url + description: The URL that provides temporary access to download the generated images. + name: Url + - value: b64_json + description: The generated images are returned as base64 encoded string. + name: Base64Json + imageSize: + description: The size of the generated images. + type: string + enum: + - 256x256 + - 512x512 + - 1792x1024 + - 1024x1792 + - 1024x1024 + default: 1024x1024 + x-ms-enum: + name: Size + modelAsString: true + values: + - value: 256x256 + description: The desired size of the generated image is 256x256 pixels. Only supported for dall-e-2. + name: Size256x256 + - value: 512x512 + description: The desired size of the generated image is 512x512 pixels. Only supported for dall-e-2. + name: Size512x512 + - value: 1792x1024 + description: The desired size of the generated image is 1792x1024 pixels. Only supported for dall-e-3. + name: Size1792x1024 + - value: 1024x1792 + description: The desired size of the generated image is 1024x1792 pixels. Only supported for dall-e-3. + name: Size1024x1792 + - value: 1024x1024 + description: The desired size of the generated image is 1024x1024 pixels. + name: Size1024x1024 + imageStyle: + description: The style of the generated images. + type: string + enum: + - vivid + - natural + default: vivid + x-ms-enum: + name: Style + modelAsString: true + values: + - value: vivid + description: Vivid creates images that are hyper-realistic and dramatic. + name: Vivid + - value: natural + description: Natural creates images that are more natural and less hyper-realistic. + name: Natural + imageGenerationsRequest: + type: object + properties: + prompt: + description: A text description of the desired image(s). The maximum length is 4000 characters. + type: string + format: string + example: a corgi in a field + minLength: 1 + "n": + description: The number of images to generate. + type: integer + minimum: 1 + maximum: 1 + default: 1 + size: + $ref: "#/components/schemas/imageSize" + response_format: + $ref: "#/components/schemas/imagesResponseFormat" + user: + description: A unique identifier representing your end-user, which can help to monitor and detect abuse. + type: string + format: string + example: user123456 + quality: + $ref: "#/components/schemas/imageQuality" + style: + $ref: "#/components/schemas/imageStyle" + required: + - prompt + generateImagesResponse: + type: object + properties: + created: + type: integer + format: unixtime + description: The unix timestamp when the operation was created. + example: "1676540381" + data: + type: array + description: The result data of the operation, if successful + items: + $ref: "#/components/schemas/imageResult" + required: + - created + - data + imageResult: + type: object + description: The image url or encoded image if successful, and an error otherwise. + properties: + url: + type: string + description: The image url. + example: https://www.contoso.com + b64_json: + type: string + description: The base64 encoded image + content_filter_results: + $ref: "#/components/schemas/dalleContentFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + prompt_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + line: + type: object + description: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. + properties: + text: + type: string + spans: + type: array + description: An array of spans that represent detected objects and its bounding box information. + items: + $ref: "#/components/schemas/span" + required: + - text + - spans + span: + type: object + description: A span object that represents a detected object and its bounding box information. + properties: + text: + type: string + description: The text content of the span that represents the detected object. + offset: + type: integer + description: The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints. + length: + type: integer + description: The length of the span in characters, measured in Unicode codepoints. + polygon: + type: array + description: An array of objects representing points in the polygon that encloses the detected object. + items: + type: object + properties: + x: + type: number + description: The x-coordinate of the point. + "y": + type: number + description: The y-coordinate of the point. + required: + - text + - offset + - length + - polygon + + runCompletionUsage: + type: object + description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). + properties: + completion_tokens: + type: integer + description: Number of completion tokens used over the course of the run. + prompt_tokens: + type: integer + description: Number of prompt tokens used over the course of the run. + total_tokens: + type: integer + description: Total number of tokens used (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + + runStepCompletionUsage: + type: object + description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. + properties: + completion_tokens: + type: integer + description: Number of completion tokens used over the course of the run step. + prompt_tokens: + type: integer + description: Number of prompt tokens used over the course of the run step. + total_tokens: + type: integer + description: Total number of tokens used (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + + assistantsApiResponseFormatOption: + description: | + Specifies the format that the model must output. Compatible with + GPT-4o, GPT-4 Turbo, + and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_schema", "json_schema": {...} }` + enables Structured Outputs which ensures the model + will match your supplied JSON schema. + Learn more in the [Structured Outputs guide](/docs/guides/structured-outputs). + + Setting to `{ "type": "json_object" }` enables + JSON mode, which ensures the message the model generates is valid JSON. + + **Important:** when using JSON mode, + you **must** also instruct the model to produce JSON yourself + via a system or user message. Without this, the model may + generate an unending stream of whitespace until the generation + reaches the token limit, resulting in a long-running and + seemingly "stuck" request. Also note that the message content + may be partially cut off if `finish_reason="length"`, which indicates + the generation exceeded `max_tokens` or the conversation exceeded + the max context length. + oneOf: + - type: string + description: > + `auto` is the default value + enum: + - auto + x-ms-enum: + name: AssistantsApiResponseFormatOption + modelAsString: true + values: + - value: auto + - $ref: "#/components/schemas/ResponseFormatText" + - $ref: "#/components/schemas/ResponseFormatJsonObject" + - $ref: "#/components/schemas/ResponseFormatJsonSchema" + + assistantsApiResponseFormat: + type: object + description: | + An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed. + properties: + type: + type: string + enum: ["text", "json_object"] + x-ms-enum: + name: AssistantsApiResponseFormat + modelAsString: true + values: + - value: text + - value: json_object + example: "json_object" + default: "text" + description: Must be one of `text` or `json_object`. + + assistantObject: + type: object + title: Assistant + description: Represents an `assistant` that can call the model and use tools. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant`. + type: string + enum: + - assistant + x-ms-enum: + name: AssistantObjectType + modelAsString: true + values: + - value: assistant + created_at: + type: integer + description: The Unix timestamp (in seconds) for when the assistant was created. + name: + description: &assistant_name_param_description | + The name of the assistant. The maximum length is 256 characters. + type: string + maxLength: 256 + nullable: true + description: + description: &assistant_description_param_description | + The description of the assistant. The maximum length is 512 characters. + type: string + maxLength: 512 + nullable: true + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + type: string + instructions: + description: &assistant_instructions_param_description | + The system instructions that the assistant uses. The maximum length is 256,000 characters. + type: string + maxLength: 256000 + nullable: true + tools: + description: &assistant_tools_param_description | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + metadata: + description: &metadata_description | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + temperature: + description: &run_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &run_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or temperature but not both. + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - metadata + + createAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: *assistant_name_param_description + type: string + nullable: true + maxLength: 256 + description: + description: *assistant_description_param_description + type: string + nullable: true + maxLength: 512 + instructions: + description: *assistant_instructions_param_description + type: string + nullable: true + maxLength: 256000 + tools: + description: *assistant_tools_param_description + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + vector_stores: + type: array + description: | + A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + maxItems: 10000 + items: + type: string + chunking_strategy: + # Ideally we'd reuse the chunking strategy schema here, but it doesn't expand properly + type: object + description: The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. + oneOf: + - type: object + title: Auto Chunking Strategy + description: The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: ["auto"] + x-ms-enum: + name: AutoChunkingStrategyType + modelAsString: true + values: + - value: auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: ["static"] + x-ms-enum: + name: StaticChunkingStrategyType + modelAsString: true + values: + - value: static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: | + The number of tokens that overlap between chunks. The default value is `400`. + + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + metadata: + type: object + description: | + Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + oneOf: + - required: [vector_store_ids] + - required: [vector_stores] + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + description: *run_temperature_description + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - model + + modifyAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: | + The name of the assistant. The maximum length is 256 characters. + type: string + nullable: true + maxLength: 256 + description: + description: | + The description of the assistant. The maximum length is 512 characters. + type: string + nullable: true + maxLength: 512 + instructions: + description: | + The system instructions that the assistant uses. The maximum length is 32768 characters. + type: string + nullable: true + maxLength: 32768 + tools: + description: | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + description: *run_temperature_description + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + + deleteAssistantResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - assistant.deleted + x-ms-enum: + name: DeleteAssistantResponseState + modelAsString: true + values: + - value: assistant.deleted + required: + - id + - object + - deleted + + listAssistantsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/assistantObject" + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + assistantToolsCode: + type: object + title: Code interpreter tool + properties: + type: + type: string + description: "The type of tool being defined: `code_interpreter`" + enum: + - code_interpreter + x-ms-enum: + name: assistantToolsCodeType + modelAsString: true + values: + - value: code_interpreter + required: + - type + + assistantToolsFileSearch: + type: object + title: FileSearch tool + properties: + type: + type: string + description: "The type of tool being defined: `file_search`" + enum: + - file_search + x-ms-enum: + name: assistantToolsFileSearchType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: Overrides for the file search tool. + properties: + max_num_results: + type: integer + minimum: 1 + maximum: 50 + description: | + The maximum number of results the file search tool should output. The + default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number + should be between 1 and 50 inclusive. + + + Note that the file search tool may output fewer than `max_num_results` + results. + assistantToolsFileSearchTypeOnly: + type: object + title: FileSearch tool + properties: + type: + type: string + description: "The type of tool being defined: `file_search`" + enum: + - file_search + x-ms-enum: + name: assistantToolsFileSearchType + modelAsString: true + values: + - value: file_search + required: + - type + + assistantToolsFunction: + type: object + title: Function tool + properties: + type: + type: string + description: "The type of tool being defined: `function`" + enum: + - function + x-ms-enum: + name: assistantToolsFunction + modelAsString: true + values: + - value: function + function: + type: object + description: The function definition. + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/chatCompletionFunctionParameters" + required: + - name + - parameters + - description + required: + - type + - function + + truncationObject: + type: object + title: Thread Truncation Controls + description: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run. + properties: + type: + type: string + description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. + enum: ["auto", "last_messages"] + x-ms-enum: + name: TruncationType + modelAsString: true + values: + - value: auto + - value: last_messages + last_messages: + type: integer + description: The number of most recent messages from the thread when constructing the context for the run. + minimum: 1 + nullable: true + required: + - type + + assistantsApiToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tools and instead generates a message. + `auto` is the default value and means the model can pick between generating a message or calling a tool. + Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + x-ms-enum: + name: AssistantsApiToolChoiceOption + modelAsString: true + values: + - value: none + - value: auto + - $ref: "#/components/schemas/assistantsNamedToolChoice" + + assistantsNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific tool. + properties: + type: + type: string + enum: ["function", "code_interpreter", "file_search"] + description: The type of the tool. If type is `function`, the function name must be set + x-ms-enum: + name: AssistantsNamedToolChoiceType + modelAsString: true + values: + - value: function + - value: code_interpreter + - value: file_search + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + + runObject: + type: object + title: A run on a thread + description: Represents an execution run on a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run`. + type: string + enum: + - thread.run + x-ms-enum: + name: runObjectType + modelAsString: true + values: + - value: thread.run + description: The run object type which is always thread.run + created_at: + description: The Unix timestamp (in seconds) for when the run was created. + type: integer + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run. + type: string + assistant_id: + description: The ID of the assistant used for execution of this run. + type: string + status: + description: The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunObjectStatus + modelAsString: true + values: + - value: queued + description: The queued state + - value: in_progress + description: The in_progress state + - value: requires_action + description: The required_action state + - value: cancelling + description: The cancelling state + - value: cancelled + description: The cancelled state + - value: failed + description: The failed state + - value: completed + description: The completed state + - value: expired + description: The expired state + required_action: + type: object + description: Details on the action required to continue the run. Will be `null` if no action is required. + nullable: true + properties: + type: + description: For now, this is always `submit_tool_outputs`. + type: string + enum: + - submit_tool_outputs + submit_tool_outputs: + type: object + description: Details on the tool outputs needed for this run to continue. + properties: + tool_calls: + type: array + description: A list of the relevant tool calls. + items: + $ref: "#/components/schemas/runToolCallObject" + required: + - tool_calls + required: + - type + - submit_tool_outputs + last_error: + type: object + description: The last error associated with this run. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server failed to respond to request due to server error + - value: rate_limit_exceeded + description: The server failed to respond to request due to rate limit exceeded + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expires_at: + description: The Unix timestamp (in seconds) for when the run will expire. + type: integer + started_at: + description: The Unix timestamp (in seconds) for when the run was started. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run was completed. + type: integer + nullable: true + incomplete_details: + description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. + type: object + nullable: true + properties: + reason: + description: The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. + type: string + enum: ["max_completion_tokens", "max_prompt_tokens"] + x-ms-enum: + name: IncompleteDetailsReason + modelAsString: true + values: + - value: max_completion_tokens + - value: max_prompt_tokens + model: + description: The model that the assistant used for this run. + type: string + instructions: + description: The instructions that the assistant used for this run. + type: string + tools: + description: The list of tools that the assistant used for this run. + default: [] + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + metadata: + description: *metadata_description + type: object + nullable: true + usage: + $ref: "#/components/schemas/runCompletionUsage" + temperature: + description: The sampling temperature used for this run. If not set, defaults to 1. + type: number + nullable: true + top_p: + description: The nucleus sampling value used for this run. If not set, defaults to 1. + type: number + nullable: true + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens specified to have been used over the course of the run. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens specified to have been used over the course of the run. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - id + - object + - created_at + - thread_id + - assistant_id + - status + - required_action + - last_error + - expires_at + - started_at + - cancelled_at + - failed_at + - completed_at + - model + - instructions + - tools + - metadata + - usage + - incomplete_details + - max_prompt_tokens + - max_completion_tokens + - truncation_strategy + - tool_choice + - response_format + + createRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the assistant to use to execute this run. + type: string + model: + description: The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + additional_instructions: + description: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. + type: string + nullable: true + additional_messages: + description: Adds additional messages to the thread before creating the run. + type: array + items: + $ref: "#/components/schemas/createMessageRequest" + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *run_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - thread_id + - assistant_id + + listRunsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/runObject" + first_id: + type: string + example: run_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: run_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + modifyRunRequest: + type: object + additionalProperties: false + properties: + metadata: + description: *metadata_description + type: object + nullable: true + + submitToolOutputsRunRequest: + type: object + additionalProperties: false + properties: + tool_outputs: + description: A list of tools for which the outputs are being submitted. + type: array + items: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call in the `required_action` object within the run object the output is being submitted for. + output: + type: string + description: The output of the tool call to be submitted to continue the run. + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + required: + - tool_outputs + + runToolCallObject: + type: object + description: Tool call objects + properties: + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint. + type: + type: string + description: The type of tool call the output is required for. For now, this is always `function`. + enum: + - function + x-ms-enum: + name: RunToolCallObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The function definition. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model expects you to pass to the function. + required: + - name + - arguments + required: + - id + - type + - function + + createThreadAndRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the assistant to use to execute this run. + type: string + thread: + $ref: "#/components/schemas/createThreadRequest" + description: If no thread is provided, an empty thread will be created. + model: + description: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *run_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - thread_id + - assistant_id + + threadObject: + type: object + title: Thread + description: Represents a thread that contains [messages](/docs/api-reference/messages). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread`. + type: string + enum: + - thread + x-ms-enum: + name: ThreadObjectType + modelAsString: true + values: + - value: thread + description: The type of thread object which is always `thread` + created_at: + description: The Unix timestamp (in seconds) for when the thread was created. + type: integer + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - tool_resources + - metadata + + createThreadRequest: + type: object + additionalProperties: false + properties: + messages: + description: A list of messages to start the thread with. + type: array + items: + $ref: "#/components/schemas/createMessageRequest" + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + vector_stores: + type: array + description: | + A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + maxItems: 10000 + items: + type: string + chunking_strategy: + # Ideally we'd reuse the chunking strategy schema here, but it doesn't expand properly + type: object + description: The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. + oneOf: + - type: object + title: Auto Chunking Strategy + description: The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: ["auto"] + x-ms-enum: + name: AutoChunkingStrategyType + modelAsString: true + values: + - value: auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: ["static"] + x-ms-enum: + name: StaticChunkingStrategyType + modelAsString: true + values: + - value: static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: | + The number of tokens that overlap between chunks. The default value is `400`. + + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + metadata: + type: object + description: | + Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + oneOf: + - required: [vector_store_ids] + - required: [vector_stores] + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + modifyThreadRequest: + type: object + additionalProperties: false + properties: + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of File IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + deleteThreadResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.deleted + x-ms-enum: + name: DeleteThreadResponseObjectState + modelAsString: true + values: + - value: thread.deleted + description: The delete thread response object state which is `thread.deleted` + required: + - id + - object + - deleted + + listThreadsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/threadObject" + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + messageObject: + type: object + title: The message object + description: Represents a message within a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message`. + type: string + enum: + - thread.message + x-ms-enum: + name: MessageObjectType + modelAsString: true + values: + - value: thread.message + description: The message object type which is `thread.message` + created_at: + description: The Unix timestamp (in seconds) for when the message was created. + type: integer + thread_id: + description: The [thread](/docs/api-reference/threads) ID that this message belongs to. + type: string + status: + description: The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. + type: string + enum: ["in_progress", "incomplete", "completed"] + x-ms-enum: + name: MessageObjectStatus + modelAsString: true + values: + - value: in_progress + - value: incomplete + - value: completed + incomplete_details: + description: On an incomplete message, details about why the message is incomplete. + type: object + properties: + reason: + type: string + description: The reason the message is incomplete. + enum: + [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_expired", + "run_failed", + ] + x-ms-enum: + name: MessageObjectIncompleteReason + modelAsString: true + values: + - value: content_filter + - value: max_tokens + - value: run_cancelled + - value: run_expired + - value: run_failed + nullable: true + required: + - reason + completed_at: + description: The Unix timestamp (in seconds) for when the message was completed. + type: integer + nullable: true + incomplete_at: + description: The Unix timestamp (in seconds) for when the message was marked as incomplete. + type: integer + nullable: true + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: + - user + - assistant + x-ms-enum: + name: MessageObjectRole + modelAsString: true + values: + - value: user + - value: assistant + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageContentImageFileObject" + - $ref: "#/components/schemas/messageContentTextObject" + assistant_id: + description: If applicable, the ID of the assistant that authored this message. + type: string + nullable: true + run_id: + description: If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message. + type: string + nullable: true + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + description: The tools to add this file to. + type: array + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearchTypeOnly" + description: A list of files attached to the message, and the tools they were added to. + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - thread_id + - status + - incomplete_details + - completed_at + - incomplete_at + - role + - content + - assistant_id + - run_id + - attachments + - metadata + + messageDeltaObject: + type: object + title: Message delta object + description: | + Represents a message delta i.e. any changed fields on a message during streaming. + properties: + id: + description: The identifier of the message, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message.delta`. + type: string + enum: ["thread.message.delta"] + x-ms-enum: + name: MessageDeltaObjectType + modelAsString: true + values: + - value: thread.message.delta + delta: + description: The delta containing the fields that have changed on the Message. + type: object + properties: + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: ["user", "assistant"] + x-ms-enum: + name: MessageDeltaObjectDeltaRole + modelAsString: true + values: + - value: user + - value: assistant + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageDeltaContentImageFileObject" + - $ref: "#/components/schemas/messageDeltaContentTextObject" + required: + - id + - object + - delta + + createMessageRequest: + type: object + additionalProperties: false + required: + - role + - content + properties: + role: + type: string + enum: + - user + - assistant + x-ms-enum: + name: CreateMessageRequestRole + modelAsString: true + values: + - value: user + - value: assistant + description: | + The role of the entity that is creating the message. Allowed values include: + - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. + - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. + content: + type: string + minLength: 1 + maxLength: 256000 + description: The content of the message. + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + description: The tools to add this file to. + type: array + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearchTypeOnly" + x-oaiExpandable: true + description: A list of files attached to the message, and the tools they should be added to. + required: + - file_id + - tools + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + modifyMessageRequest: + type: object + additionalProperties: false + properties: + metadata: + description: *metadata_description + type: object + nullable: true + deleteMessageResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.message.deleted + x-ms-enum: + name: DeleteMessageResponseObject + modelAsString: true + values: + - value: thread.message.deleted + description: The delete message response object state + required: + - id + - object + - deleted + listMessagesResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/messageObject" + first_id: + type: string + example: msg_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: msg_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + messageContentImageFileObject: + title: Image file + type: object + description: References an image file in the content of a message. + properties: + type: + description: Always `image_file`. + type: string + enum: + - image_file + x-ms-enum: + name: MessageContentImageFileObjectType + modelAsString: true + values: + - value: image_file + description: The message content image file type + image_file: + type: object + properties: + file_id: + description: The file ID of the image in the message content. + type: string + required: + - file_id + required: + - type + - image_file + + messageContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + type: + description: Always `text`. + type: string + enum: + - text + x-ms-enum: + name: messageContentTextObjectType + modelAsString: true + values: + - value: text + description: The message content text Object type + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + - $ref: "#/components/schemas/messageContentTextAnnotationsFilePathObject" + required: + - value + - annotations + required: + - type + - text + + messageContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files. + properties: + type: + description: Always `file_citation`. + type: string + enum: + - file_citation + x-ms-enum: + name: FileCitationObjectType + modelAsString: true + values: + - value: file_citation + description: The file citation object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_citation + - start_index + - end_index + + messageContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + type: + description: Always `file_path`. + type: string + enum: + - file_path + x-ms-enum: + name: FilePathObjectType + modelAsString: true + values: + - value: file_path + description: The file path object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_path + - start_index + - end_index + + messageDeltaContentImageFileObject: + title: Image file + type: object + description: References an image File in the content of a message. + properties: + index: + type: integer + description: The index of the content part in the message. + type: + description: Always `image_file`. + type: string + enum: ["image_file"] + x-ms-enum: + name: MessageDeltaContentImageFileObjectType + modelAsString: true + values: + - value: image_file + image_file: + type: object + properties: + file_id: + description: The File ID of the image in the message content. + type: string + required: + - index + - type + + messageDeltaContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + index: + type: integer + description: The index of the content part in the message. + type: + description: Always `text`. + type: string + enum: ["text"] + x-ms-enum: + name: MessageDeltaContentTextObjectType + modelAsString: true + values: + - value: text + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageDeltaContentTextAnnotationsFileCitationObject" + - $ref: "#/components/schemas/messageDeltaContentTextAnnotationsFilePathObject" + required: + - index + - type + + messageDeltaContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. + properties: + index: + type: integer + description: The index of the annotation in the text content part. + type: + description: Always `file_citation`. + type: string + enum: ["file_citation"] + x-ms-enum: + name: MessageDeltaContentTextAnnotationsFileCitationObjectType + modelAsString: true + values: + - value: file_citation + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + quote: + description: The specific quote in the file. + type: string + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - index + - type + + messageDeltaContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + index: + type: integer + description: The index of the annotation in the text content part. + type: + description: Always `file_path`. + type: string + enum: ["file_path"] + x-ms-enum: + name: MessageDeltaContentTextAnnotationsFilePathObjectType + modelAsString: true + values: + - value: file_path + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - index + - type + + runStepObject: + type: object + title: Run steps + description: | + Represents a step in execution of a run. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant.run.step``. + type: string + enum: + - assistant.run.step + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: assistant.run.step + description: The object type, which is always `assistant.run.step` + created_at: + description: The Unix timestamp (in seconds) for when the run step was created. + type: integer + assistant_id: + description: The ID of the assistant associated with the run step. + type: string + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was run. + type: string + run_id: + description: The ID of the [run](/docs/api-reference/runs) that this run step is a part of. + type: string + type: + description: The type of run step, which can be either `message_creation` or `tool_calls`. + type: string + enum: + - message_creation + - tool_calls + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: message_creation + description: The message_creation run step + - value: tool_calls + description: The tool_calls run step + status: + description: The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunStepObjectStatus + modelAsString: true + values: + - value: in_progress + description: The in_progress run status + - value: cancelled + description: The cancelled run status + - value: failed + description: The cancelled run status + - value: completed + description: The cancelled run status + - value: expired + description: The cancelled run status + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: "#/components/schemas/runStepDetailsMessageCreationObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsObject" + last_error: + type: object + description: The last error associated with this run step. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server_error + - value: rate_limit_exceeded + description: The rate_limit_exceeded status + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expired_at: + description: The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run step was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run step failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run step completed. + type: integer + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - assistant_id + - thread_id + - run_id + - type + - status + - step_details + - last_error + - expired_at + - cancelled_at + - failed_at + - completed_at + - metadata + + runStepDeltaObject: + type: object + title: Run step delta object + description: | + Represents a run step delta i.e. any changed fields on a run step during streaming. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run.step.delta`. + type: string + enum: ["thread.run.step.delta"] + x-ms-enum: + name: RunStepDeltaObjectType + modelAsString: true + values: + - value: thread.run.step.delta + delta: + description: The delta containing the fields that have changed on the run step. + type: object + properties: + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsMessageCreationObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsObject" + required: + - id + - object + - delta + + listRunStepsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/runStepObject" + first_id: + type: string + example: step_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: step_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + runStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation``. + type: string + enum: + - message_creation + x-ms-enum: + name: RunStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - message_id + required: + - type + - message_creation + + runStepDeltaStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation`. + type: string + enum: ["message_creation"] + x-ms-enum: + name: RunStepDeltaStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - type + + runStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: + - tool_calls + x-ms-enum: + name: RunStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval` or `function`. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsFileSearchObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsFunctionObject" + required: + - type + - tool_calls + + runStepDeltaStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: ["tool_calls"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search` or `function`. + items: + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsFileSearchObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsFunctionObject" + required: + - type + + runStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: + - code_interpreter + x-ms-enum: + name: RunStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + required: + - input + - outputs + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + required: + - id + - type + - code_interpreter + + runStepDeltaStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: ["code_interpreter"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject" + required: + - index + - type + + runStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + type: + description: Always `logs`. + type: string + enum: + - logs + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: logs + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - type + - logs + + runStepDeltaStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + index: + type: integer + description: The index of the output in the outputs array. + type: + description: Always `logs`. + type: string + enum: ["logs"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: logs + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - index + - type + + runStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + type: + description: Always `image`. + type: string + enum: + - image + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputImageObjectType + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The file ID of the image. + type: string + required: + - file_id + required: + - type + - image + + runStepDeltaStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + index: + type: integer + description: The index of the output in the outputs array. + type: + description: Always `image`. + type: string + enum: ["image"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The file ID of the image. + type: string + required: + - index + - type + + runStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `file_search` for this type of tool call. + enum: ["file_search"] + x-ms-enum: + name: RunStepDetailsToolCallsFileSearchObjectType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: For now, this is always going to be an empty object. + properties: + results: + type: array + description: The results of the file search. + items: + $ref: "#/components/schemas/runStepDetailsToolCallsFileSearchResultObject" + required: + - id + - type + - file_search + + runStepDetailsToolCallsFileSearchResultObject: + title: File search tool call result + type: object + description: A result instance of the file search. + x-oaiTypeLabel: map + properties: + file_id: + type: string + description: The ID of the file that result was found in. + file_name: + type: string + description: The name of the file that result was found in. + score: + type: number + description: The score of the result. All values must be a floating point number between 0 and 1. + minimum: 0 + maximum: 1 + content: + type: array + description: The content of the result that was found. The content is only included if requested via the include query parameter. + items: + type: object + properties: + type: + type: string + description: The type of the content. + enum: ["text"] + text: + type: string + description: The text content of the file. + required: + - file_id + - file_name + - score + + runStepDeltaStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `retrieval` for this type of tool call. + enum: + - file_search + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsFileSearchObjectType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: For now, this is always going to be an empty object. + required: + - index + - type + - file_search + + runStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: + - function + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet. + nullable: true + required: + - name + - arguments + - output + required: + - id + - type + - function + + runStepDeltaStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: ["function"] + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been submitted yet. + nullable: true + required: + - index + - type + + vectorStoreExpirationAfter: + type: object + title: Vector store expiration policy + description: The expiration policy for a vector store. + properties: + anchor: + description: "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`." + type: string + enum: ["last_active_at"] + x-ms-enum: + name: VectorStoreExpirationAfterAnchor + modelAsString: true + values: + - value: last_active_at + description: The anchor timestamp after which the expiration policy applies. + days: + description: The number of days after the anchor time that the vector store will expire. + type: integer + minimum: 1 + maximum: 365 + required: + - anchor + - days + + vectorStoreObject: + type: object + title: Vector store + description: A vector store is a collection of processed files can be used by the `file_search` tool. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store`. + type: string + enum: ["vector_store"] + created_at: + description: The Unix timestamp (in seconds) for when the vector store was created. + type: integer + name: + description: The name of the vector store. + type: string + usage_bytes: + description: The total number of bytes used by the files in the vector store. + type: integer + file_counts: + type: object + properties: + in_progress: + description: The number of files that are currently being processed. + type: integer + completed: + description: The number of files that have been successfully processed. + type: integer + failed: + description: The number of files that have failed to process. + type: integer + cancelled: + description: The number of files that were cancelled. + type: integer + total: + description: The total number of files. + type: integer + required: + - in_progress + - completed + - failed + - cancelled + - total + status: + description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. + type: string + enum: ["expired", "in_progress", "completed"] + x-ms-enum: + name: VectorStoreObjectStatus + modelAsString: true + values: + - value: expired + - value: in_progress + - value: completed + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + expires_at: + description: The Unix timestamp (in seconds) for when the vector store will expire. + type: integer + nullable: true + last_active_at: + description: The Unix timestamp (in seconds) for when the vector store was last active. + type: integer + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - usage_bytes + - created_at + - status + - last_active_at + - name + - bytes + - file_counts + - metadata + + createVectorStoreRequest: + type: object + additionalProperties: false + properties: + file_ids: + description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. + type: array + maxItems: 500 + items: + type: string + name: + description: The name of the vector store. + type: string + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + chunking_strategy: + type: object + description: >- + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. Only applicable if `file_ids` is non-empty. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + metadata: + description: *metadata_description + type: object + nullable: true + + updateVectorStoreRequest: + type: object + additionalProperties: false + properties: + name: + description: The name of the vector store. + type: string + nullable: true + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + listVectorStoresResponse: + properties: + object: + type: string + example: "list" + data: + type: array + items: + $ref: "#/components/schemas/vectorStoreObject" + first_id: + type: string + example: "vs_abc123" + last_id: + type: string + example: "vs_abc456" + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + deleteVectorStoreResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: [vector_store.deleted] + x-ms-enum: + name: DeleteVectorStoreResponseObject + modelAsString: true + values: + - value: vector_store.deleted + description: The delete vector store response object state + required: + - id + - object + - deleted + + vectorStoreFileObject: + type: object + title: Vector store files + description: A list of files attached to a vector store. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store.file`. + type: string + enum: ["vector_store.file"] + x-ms-enum: + name: VectorStoreFileObjectType + modelAsString: true + values: + - value: vector_store.file + usage_bytes: + description: The total vector store usage in bytes. Note that this may be different from the original file size. + type: integer + created_at: + description: The Unix timestamp (in seconds) for when the vector store file was created. + type: integer + vector_store_id: + description: The ID of the vector store that the file is attached to. + type: string + status: + description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. + type: string + enum: ["in_progress", "completed", "cancelled", "failed"] + x-ms-enum: + name: VectorStoreFileObjectStatus + modelAsString: true + values: + - value: in_progress + - value: completed + - value: cancelled + - value: failed + last_error: + type: object + description: The last error associated with this vector store file. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `invalid_file` or `unsupported_file`. + enum: + [ + "server_error", + "unsupported_file", + "invalid_file" + ] + x-ms-enum: + name: VectorStoreFileObjectLastErrorCode + modelAsString: true + values: + - value: server_error + - value: unsupported_file + - value: invalid_file + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + chunking_strategy: + type: object + description: | + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. Only applicable if `file_ids` is non-empty. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + required: + - id + - object + - usage_bytes + - created_at + - vector_store_id + - status + - last_error + + otherChunkingStrategyResponseParam: + type: object + title: Other Chunking Strategy + description: | + This is returned when the chunking strategy is unknown. Typically, this is + because the file was indexed before the `chunking_strategy` concept was + introduced in the API. + additionalProperties: false + properties: + type: + type: string + description: Always `other`. + enum: + - other + x-ms-enum: + name: OtherChunkingStrategyResponseParamType + modelAsString: true + values: + - value: other + required: + - type + + staticChunkingStrategyResponseParam: + type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: + - static + x-ms-enum: + name: StaticChunkingStrategyResponseParamType + modelAsString: true + values: + - value: static + static: + $ref: "#/components/schemas/staticChunkingStrategy" + required: + - type + - static + + staticChunkingStrategy: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: | + The maximum number of tokens in each chunk. The default value is `800`. + The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: > + The number of tokens that overlap between chunks. The default value is + `400`. + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + + autoChunkingStrategyRequestParam: + type: object + title: Auto Chunking Strategy + description: | + The default strategy. This strategy currently uses a `max_chunk_size_tokens` + of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: + - auto + required: + - type + + staticChunkingStrategyRequestParam: + type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: + - static + static: + $ref: "#/components/schemas/staticChunkingStrategy" + required: + - type + - static + + chunkingStrategyRequestParam: + type: object + description: >- + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + + createVectorStoreFileRequest: + type: object + additionalProperties: false + properties: + file_id: + description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. + type: string + chunking_strategy: + $ref: "#/components/schemas/chunkingStrategyRequestParam" + required: + - file_id + + listVectorStoreFilesResponse: + properties: + object: + type: string + example: "list" + data: + type: array + items: + $ref: "#/components/schemas/vectorStoreFileObject" + first_id: + type: string + example: "file-abc123" + last_id: + type: string + example: "file-abc456" + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + deleteVectorStoreFileResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: [vector_store.file.deleted] + x-ms-enum: + name: DeleteVectorStoreFileResponseObject + modelAsString: true + values: + - value: vector_store.file.deleted + required: + - id + - object + - deleted + + vectorStoreFileBatchObject: + type: object + title: Vector store file batch + description: A batch of files attached to a vector store. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store.file_batch`. + type: string + enum: ["vector_store.files_batch"] + x-ms-enum: + name: VectorStoreFileBatchObjectType + modelAsString: true + values: + - value: vector_store.files_batch + created_at: + description: The Unix timestamp (in seconds) for when the vector store files batch was created. + type: integer + vector_store_id: + description: The ID of the vector store that the File is attached to. + type: string + status: + description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. + type: string + enum: ["in_progress", "completed", "cancelled", "failed"] + x-ms-enum: + name: VectorStoreFileBatchObjectStatus + modelAsString: true + values: + - value: in_progress + - value: completed + - value: cancelled + - value: failed + file_counts: + type: object + properties: + in_progress: + description: The number of files that are currently being processed. + type: integer + completed: + description: The number of files that have been processed. + type: integer + failed: + description: The number of files that have failed to process. + type: integer + cancelled: + description: The number of files that where cancelled. + type: integer + total: + description: The total number of files. + type: integer + required: + - in_progress + - completed + - cancelled + - failed + - total + required: + - id + - object + - created_at + - vector_store_id + - status + - file_counts + + createVectorStoreFileBatchRequest: + type: object + additionalProperties: false + properties: + file_ids: + description: A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. + type: array + minItems: 1 + maxItems: 500 + items: + type: string + chunking_strategy: + $ref: "#/components/schemas/chunkingStrategyRequestParam" + required: + - file_ids + + assistantStreamEvent: + description: | + Represents an event emitted when streaming a Run. + + Each event in a server-sent events stream has an `event` and `data` property: + + ``` + event: thread.created + data: {"id": "thread_123", "object": "thread", ...} + ``` + + We emit events whenever a new object is created, transitions to a new state, or is being + streamed in parts (deltas). For example, we emit `thread.run.created` when a new run + is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses + to create a message during a run, we emit a `thread.message.created event`, a + `thread.message.in_progress` event, many `thread.message.delta` events, and finally a + `thread.message.completed` event. + + We may add additional events over time, so we recommend handling unknown events gracefully + in your code. + oneOf: + - $ref: "#/components/schemas/threadStreamEvent" + - $ref: "#/components/schemas/runStreamEvent" + - $ref: "#/components/schemas/runStepStreamEvent" + - $ref: "#/components/schemas/messageStreamEvent" + - $ref: "#/components/schemas/errorEvent" + - $ref: "#/components/schemas/doneEvent" + + threadStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.created"] + x-ms-enum: + name: ThreadStreamEventEnum + modelAsString: true + values: + - value: thread.created + description: The thread created event + data: + $ref: "#/components/schemas/threadObject" + required: + - event + - data + description: Occurs when a new thread is created. + + runStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.run.created"] + x-ms-enum: + name: RunStreamEventCreated + modelAsString: true + values: + - value: thread.run.created + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a new run is created. + - type: object + properties: + event: + type: string + enum: ["thread.run.queued"] + x-ms-enum: + name: RunStreamEventQueued + modelAsString: true + values: + - value: thread.run.queued + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `queued` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.in_progress"] + x-ms-enum: + name: RunStreamEventInProgress + modelAsString: true + values: + - value: thread.run.in_progress + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to an `in_progress` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.requires_action"] + x-ms-enum: + name: RunStreamEventRequiresAction + modelAsString: true + values: + - value: thread.run.requires_action + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `requires_action` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.completed"] + x-ms-enum: + name: RunStreamEventCompleted + modelAsString: true + values: + - value: thread.run.completed + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run is completed. + - type: object + properties: + event: + type: string + enum: ["thread.run.failed"] + x-ms-enum: + name: RunStreamEventFailed + modelAsString: true + values: + - value: thread.run.failed + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run fails. + - type: object + properties: + event: + type: string + enum: ["thread.run.cancelling"] + x-ms-enum: + name: RunStreamEventCancelling + modelAsString: true + values: + - value: thread.run.cancelling + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `cancelling` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.cancelled"] + x-ms-enum: + name: RunStreamEventCancelled + modelAsString: true + values: + - value: thread.run.cancelled + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run is cancelled. + - type: object + properties: + event: + type: string + enum: ["thread.run.expired"] + x-ms-enum: + name: RunStreamEventExpired + modelAsString: true + values: + - value: thread.run.expired + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run expires. + + runStepStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.run.step.created"] + x-ms-enum: + name: RunStepStreamEventCreated + modelAsString: true + values: + - value: thread.run.step.created + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is created. + + - type: object + properties: + event: + type: string + enum: ["thread.run.step.in_progress"] + x-ms-enum: + name: RunStepStreamEventInProgress + modelAsString: true + values: + - value: thread.run.step.in_progress + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step moves to an `in_progress` state. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.delta"] + x-ms-enum: + name: RunStepStreamEventDelta + modelAsString: true + values: + - value: thread.run.step.delta + data: + $ref: "#/components/schemas/runStepDeltaObject" + required: + - event + - data + description: Occurs when parts of a run step are being streamed. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.completed"] + x-ms-enum: + name: RunStepStreamEventCompleted + modelAsString: true + values: + - value: thread.run.step.completed + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is completed. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.failed"] + x-ms-enum: + name: RunStepStreamEventFailed + modelAsString: true + values: + - value: thread.run.step.failed + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step fails. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.cancelled"] + x-ms-enum: + name: RunStepStreamEventCancelled + modelAsString: true + values: + - value: thread.run.step.cancelled + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is cancelled. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.expired"] + x-ms-enum: + name: RunStepStreamEventExpired + modelAsString: true + values: + - value: thread.run.step.expired + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step expires. + + messageStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.message.created"] + x-ms-enum: + name: MessageStreamEventCreated + modelAsString: true + values: + - value: thread.message.created + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message is created. + - type: object + properties: + event: + type: string + enum: ["thread.message.in_progress"] + x-ms-enum: + name: MessageStreamEventInProgress + modelAsString: true + values: + - value: thread.message.in_progress + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message moves to an `in_progress` state. + - type: object + properties: + event: + type: string + enum: ["thread.message.delta"] + x-ms-enum: + name: MessageStreamEventDelta + modelAsString: true + values: + - value: thread.message.delta + data: + $ref: "#/components/schemas/messageDeltaObject" + required: + - event + - data + description: Occurs when parts of a message are being streamed. + - type: object + properties: + event: + type: string + enum: ["thread.message.completed"] + x-ms-enum: + name: MessageStreamEventCompleted + modelAsString: true + values: + - value: thread.message.completed + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message is completed. + - type: object + properties: + event: + type: string + enum: ["thread.message.incomplete"] + x-ms-enum: + name: MessageStreamEventIncomplete + modelAsString: true + values: + - value: thread.message.incomplete + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message ends before it is completed. + + errorEvent: + type: object + properties: + event: + type: string + enum: ["error"] + x-ms-enum: + name: ErrorEventEnum + modelAsString: true + values: + - value: error + data: + $ref: "#/components/schemas/error" + required: + - event + - data + description: Occurs when an error occurs. This can happen due to an internal server error or a timeout. + + doneEvent: + type: object + properties: + event: + type: string + enum: ["done"] + x-ms-enum: + name: DoneEventEnum + modelAsString: true + values: + - value: done + data: + type: string + enum: ["[DONE]"] + x-ms-enum: + name: DoneEventDataEnum + modelAsString: true + values: + - value: "[DONE]" + required: + - event + - data + description: Occurs when a stream ends. + securitySchemes: + bearer: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: {} + x-tokenInfoFunc: api.middleware.auth.bearer_auth + x-scopeValidateFunc: api.middleware.auth.validate_scopes + apiKey: + type: apiKey + name: api-key + in: header diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index 3f37a5c7bbc2..ed442b99e743 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -308,3 +308,10 @@ These settings apply only when `--tag=release_2024_12_01_preview` is specified o ``` yaml $(tag) == 'release_2024_12_01_preview' input-file: preview/2024-12-01-preview/inference.json ``` + +## AzureOpenAI 2025-01-01-preview +These settings apply only when `--tag=release_2025_01_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025_01_01_preview' +input-file: preview/2025-01-01-preview/inference.json +``` From 3682aa5a72ec0d25167b6b6555946ca63fc83231 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 29 Jan 2025 12:04:49 -0800 Subject: [PATCH 64/74] [EngSys] Default all workflow perms to "content: read" (#32388) - Should have no real-world security impact - Follows principle of least-priviliges --- .github/workflows/SDK-Suppressions-Label.yaml | 5 +++-- .github/workflows/_reusable-eng-tools-test.yaml | 3 +++ .github/workflows/github-test.yaml | 3 +++ .github/workflows/protected-files.yaml | 3 +++ .github/workflows/specs-model-test.yaml | 3 +++ .github/workflows/spelling-all.yaml | 3 +++ .github/workflows/spelling.yaml | 3 +++ .github/workflows/suppressions-test.yaml | 3 +++ .github/workflows/tsp-client-test.yaml | 3 +++ .github/workflows/typespec-requirement-test.yaml | 3 +++ .github/workflows/typespec-requirement.yaml | 3 +++ .github/workflows/typespec-validation-all.yaml | 3 +++ .github/workflows/typespec-validation-test.yaml | 3 +++ .github/workflows/typespec-validation.yaml | 3 +++ .github/workflows/update-labels.yaml | 3 +++ 15 files changed, 45 insertions(+), 2 deletions(-) diff --git a/.github/workflows/SDK-Suppressions-Label.yaml b/.github/workflows/SDK-Suppressions-Label.yaml index 5bb561551d17..e62f580ea5a6 100644 --- a/.github/workflows/SDK-Suppressions-Label.yaml +++ b/.github/workflows/SDK-Suppressions-Label.yaml @@ -7,12 +7,13 @@ on: - RPSaaSMaster - release* +permissions: + contents: read + jobs: process-sdk-suppressions-labels: name: Sdk Suppressions runs-on: ubuntu-24.04 - permissions: - contents: read steps: - name: Checkout code uses: actions/checkout@v4 diff --git a/.github/workflows/_reusable-eng-tools-test.yaml b/.github/workflows/_reusable-eng-tools-test.yaml index 8150b362ec92..bfa7e942e821 100644 --- a/.github/workflows/_reusable-eng-tools-test.yaml +++ b/.github/workflows/_reusable-eng-tools-test.yaml @@ -20,6 +20,9 @@ on: required: false type: boolean +permissions: + contents: read + jobs: test: strategy: diff --git a/.github/workflows/github-test.yaml b/.github/workflows/github-test.yaml index 1c67764b447e..3837e68c3b23 100644 --- a/.github/workflows/github-test.yaml +++ b/.github/workflows/github-test.yaml @@ -11,6 +11,9 @@ on: - .github/** workflow_dispatch: +permissions: + contents: read + defaults: run: shell: bash diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 291d123b1694..4758ffc639d9 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -2,6 +2,9 @@ name: Protected Files on: pull_request +permissions: + contents: read + env: # Users allowed to edit protected files without failing check user-allowed: ${{ github.event.pull_request.user.login == 'azure-sdk' }} diff --git a/.github/workflows/specs-model-test.yaml b/.github/workflows/specs-model-test.yaml index 6fcfd221dbd8..e037e01d5e16 100644 --- a/.github/workflows/specs-model-test.yaml +++ b/.github/workflows/specs-model-test.yaml @@ -17,6 +17,9 @@ on: - eng/tools/specs-model/** workflow_dispatch: +permissions: + contents: read + jobs: specsModel: name: Specs Model diff --git a/.github/workflows/spelling-all.yaml b/.github/workflows/spelling-all.yaml index 1e5265e6a08f..ff630facac40 100644 --- a/.github/workflows/spelling-all.yaml +++ b/.github/workflows/spelling-all.yaml @@ -11,6 +11,9 @@ on: - cron: "6 12 * * *" workflow_dispatch: +permissions: + contents: read + jobs: spellcheck: name: SpellCheck diff --git a/.github/workflows/spelling.yaml b/.github/workflows/spelling.yaml index d13ff43ee2f5..8410d19ec91e 100644 --- a/.github/workflows/spelling.yaml +++ b/.github/workflows/spelling.yaml @@ -2,6 +2,9 @@ name: SpellCheck on: pull_request +permissions: + contents: read + jobs: spellcheck: name: SpellCheck diff --git a/.github/workflows/suppressions-test.yaml b/.github/workflows/suppressions-test.yaml index eaff138a71d0..9d3cc047169e 100644 --- a/.github/workflows/suppressions-test.yaml +++ b/.github/workflows/suppressions-test.yaml @@ -17,6 +17,9 @@ on: - eng/tools/suppressions/** workflow_dispatch: +permissions: + contents: read + jobs: suppressions: uses: ./.github/workflows/_reusable-eng-tools-test.yaml diff --git a/.github/workflows/tsp-client-test.yaml b/.github/workflows/tsp-client-test.yaml index ec54c29ad636..33730e9a377b 100644 --- a/.github/workflows/tsp-client-test.yaml +++ b/.github/workflows/tsp-client-test.yaml @@ -20,6 +20,9 @@ on: - specification/contosowidgetmanager workflow_dispatch: +permissions: + contents: read + jobs: tsp-client: uses: ./.github/workflows/_reusable-eng-tools-test.yaml diff --git a/.github/workflows/typespec-requirement-test.yaml b/.github/workflows/typespec-requirement-test.yaml index d65a92f13808..922b34fd19a3 100644 --- a/.github/workflows/typespec-requirement-test.yaml +++ b/.github/workflows/typespec-requirement-test.yaml @@ -17,6 +17,9 @@ on: - eng/tools/typespec-requirement/** workflow_dispatch: +permissions: + contents: read + jobs: typespec-requirement: uses: ./.github/workflows/_reusable-eng-tools-test.yaml diff --git a/.github/workflows/typespec-requirement.yaml b/.github/workflows/typespec-requirement.yaml index c5c2a2c841e0..ece2e6fc78d6 100644 --- a/.github/workflows/typespec-requirement.yaml +++ b/.github/workflows/typespec-requirement.yaml @@ -2,6 +2,9 @@ name: TypeSpec Requirement on: pull_request +permissions: + contents: read + jobs: TypeSpec-Requirement: name: TypeSpec Requirement diff --git a/.github/workflows/typespec-validation-all.yaml b/.github/workflows/typespec-validation-all.yaml index 93092ad7d9a7..02fea60a3a5c 100644 --- a/.github/workflows/typespec-validation-all.yaml +++ b/.github/workflows/typespec-validation-all.yaml @@ -32,6 +32,9 @@ on: workflow_dispatch: +permissions: + contents: read + jobs: typespec-validation-all: # Use short name to maximize space for parameters in UI diff --git a/.github/workflows/typespec-validation-test.yaml b/.github/workflows/typespec-validation-test.yaml index 5387ed97b074..7d565bcf4b64 100644 --- a/.github/workflows/typespec-validation-test.yaml +++ b/.github/workflows/typespec-validation-test.yaml @@ -18,6 +18,9 @@ on: - eng/tools/typespec-validation/** workflow_dispatch: +permissions: + contents: read + jobs: typespec-validation: uses: ./.github/workflows/_reusable-eng-tools-test.yaml diff --git a/.github/workflows/typespec-validation.yaml b/.github/workflows/typespec-validation.yaml index 99f01422fd28..813029a8e8ee 100644 --- a/.github/workflows/typespec-validation.yaml +++ b/.github/workflows/typespec-validation.yaml @@ -2,6 +2,9 @@ name: TypeSpec Validation on: pull_request +permissions: + contents: read + jobs: typespec-validation: name: TypeSpec Validation diff --git a/.github/workflows/update-labels.yaml b/.github/workflows/update-labels.yaml index ff09b5284a5f..9fa6c118fc05 100644 --- a/.github/workflows/update-labels.yaml +++ b/.github/workflows/update-labels.yaml @@ -29,6 +29,9 @@ on: required: false type: number +permissions: + contents: read + jobs: update-labels: name: Update Labels From 3d89480a5040927159f42fa3f464e0cb5f837c85 Mon Sep 17 00:00:00 2001 From: Bill Wert Date: Wed, 29 Jan 2025 14:09:28 -0800 Subject: [PATCH 65/74] Eg sysevents package updates (#32368) * in progress * fixes for sysevents package generation * apiview feedback * Remove deprecated service * formatting fixes --------- Co-authored-by: Libba Lawrence --- .../propertyNameOverride.tsp | 1 + .../propertyNameOverrideJava.tsp | 195 ++++++++++++++++++ .../tspconfig.yaml | 11 + 3 files changed, 207 insertions(+) create mode 100644 specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJava.tsp diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp index 9f0dd0e0acc7..b50f500f1ab5 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverride.tsp @@ -10,6 +10,7 @@ import "./Microsoft.EventGrid/EventGrid.tsp"; import "./propertyNameOverrideGo.tsp"; import "./propertyNameOverrideCsharp.tsp"; import "./propertyNameOverrideJs.tsp"; +import "./propertyNameOverrideJava.tsp"; import "@azure-tools/typespec-client-generator-core"; diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJava.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJava.tsp new file mode 100644 index 000000000000..b29a2faea215 --- /dev/null +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/propertyNameOverrideJava.tsp @@ -0,0 +1,195 @@ +import "./Microsoft.Communication/AzureCommunicationServices.tsp"; +import "./Microsoft.EventHub/EventHub.tsp"; +import "./Microsoft.HealthcareApis/HealthcareApis.tsp"; +import "./Microsoft.Devices/IotHub.tsp"; +import "./Microsoft.ResourceNotifications/Resources.tsp"; +import "./Microsoft.Storage/Storage.tsp"; +import "./Microsoft.DataBox/DataBox.tsp"; +import "./Microsoft.EventGrid/EventGrid.tsp"; +import "./Microsoft.AVS/AVS.tsp"; +import "./Microsoft.KeyVault/KeyVault.tsp"; + +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.EventGrid.SystemEvents; + +@@clientName(AcsIncomingCallEventData.to, "toCommunicationIdentifier", "java"); +@@clientName(AcsIncomingCallEventData.from, + "fromCommunicationIdentifier", + "java" +); + +@@clientName(AcsIncomingCallEventData.onBehalfOfCallee, + "onBehalfOfCommunicationIdentifier", + "java" +); + +@@clientName(AcsMessageMediaContent.id, "mediaId", "java"); + +@@clientName(AcsMessageContext.id, "messageId", "java"); + +@@clientName(AcsRouterWorkerSelector.ttlSeconds, "timeToLive", "java"); + +@@clientName(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveContent.type, + "replyKind", + "java" +); + +@@clientName(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveButtonReplyContent.id, + "buttonId", + "java" +); + +@@clientName(Microsoft.EventGrid.SystemEvents.AcsMessageInteractiveListReplyContent.id, + "listItemId", + "java" +); + +@@clientName(AcsRecordingFileStatusUpdatedEventData.recordingDurationMs, + "recordingDuration", + "java" +); + +@@clientName(EventGridMQTTClientCreatedOrUpdatedEventData, + "EventGridMqttClientCreatedOrUpdatedEventData", + "java" +); + +@@clientName(EventGridMQTTClientDeletedEventData, + "EventGridMqttClientDeletedEventData", + "java" +); + +@@clientName(EventGridMQTTClientSessionConnectedEventData, + "EventGridMqttClientSessionConnectedEventData", + "java" +); + +@@clientName(EventGridMQTTClientSessionDisconnectedEventData, + "EventGridMqttClientSessionDisconnectedEventData", + "java" +); + +@@clientName(EventGridMQTTClientEventData, + "EventGridMqttClientEventData", + "java" +); + +@@clientName(EventGridMQTTClientState, "EventGridMqttClientState", "java"); + +@@clientName(EventGridMQTTClientDisconnectionReason, + "EventGridMqttClientDisconnectionReason", + "java" +); + +@@clientName(RedisImportRDBCompletedEventData, + "RedisImportRdbCompletedEventData", + "java" +); + +@@clientName(RedisExportRDBCompletedEventData, + "RedisExportRdbCompletedEventData", + "java" +); + +@@clientName(AcsRouterWorkerSelector.value, "labelValue", "java"); + +@@clientName(AcsRecordingFileStatusUpdatedEventData.recordingDurationMs, + "recordingDuration", + "java" +); + +@@clientName(StorageTaskAssignmentQueuedEventData.queuedDateTime, + "queuedOn", + "java" +); + +@@clientName(KeyVaultAccessPolicyChangedEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultAccessPolicyChangedEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultCertificateNewVersionCreatedEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultCertificateNewVersionCreatedEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultCertificateExpiredEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultCertificateExpiredEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultKeyNewVersionCreatedEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultKeyNewVersionCreatedEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultKeyNearExpiryEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultKeyNearExpiryEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultKeyExpiredEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultKeyExpiredEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultSecretNewVersionCreatedEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultSecretNewVersionCreatedEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultSecretNearExpiryEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultSecretNearExpiryEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultSecretExpiredEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultSecretExpiredEventData.EXP, "Exp", "java"); + +@@clientName(KeyVaultCertificateNearExpiryEventData.NBF, "Nbf", "java"); + +@@clientName(KeyVaultCertificateNearExpiryEventData.EXP, "Exp", "java"); + +@@clientName(AcsMessageDeliveryStatusUpdatedEventData.channelType, + "channelKind", + "java" +); + +@@clientName(AcsMessageReceivedEventData.channelType, "channelKind", "java"); + +@@clientName(AcsMessageReceivedEventData.media, "mediaContent", "java"); + +@@clientName(AcsMessageReceivedEventData.interactive, + "interactiveContent", + "java" +); + +@@clientName(ResourceNotificationsResourceDeletedEventData.operationalInfo, + "operationalDetails", + "java" +); + +@@clientName(ResourceNotificationsResourceDeletedEventData.resourceInfo, + "resourceDetails", + "java" +); + +@@clientName(ResourceNotificationsResourceUpdatedEventData.operationalInfo, + "operationalDetails", + "java" +); + +@@clientName(ResourceNotificationsResourceUpdatedEventData.resourceInfo, + "resourceDetails", + "java" +); + +@@clientName(CommunicationIdentifierModelKind, + "CommunicationIdentifierKind", + "java" +); + +@@clientName(MicrosoftTeamsAppIdentifierModel, + "MicrosoftTeamsAppIdentifier", + "java" +); + +@@clientName(AcsMessageEventData.receivedTimeStamp, + "receivedTimestamp", + "java" +); diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index 2982f8f18666..a50d06d6282c 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -44,3 +44,14 @@ options: module-version: "0.0.1" emitter-output-dir: "{project-root}" slice-elements-byval: true + "@azure-tools/typespec-java": + emitter-output-dir: "{project-root}" + namespace: com.azure.messaging.eventgrid + models-subpackage: systemevents + package-dir: azure-messaging-eventgrid-systemevents + customization-class: customization/src/main/java/EventGridSystemEventsCustomization.java + custom-types-subpackage: implementation.models + custom-types: AcsRouterCommunicationError,AcsMessageChannelEventError + flavor: azure + dev-options: + loglevel: info From f0a997bf4f5a1e7281c8f2e91e27e1a39c271d11 Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Wed, 29 Jan 2025 14:57:50 -0800 Subject: [PATCH 66/74] Sync eng/common directory with azure-sdk-tools for PR 9724 (#32394) * Use 1es template * Move to stage template folder --------- Co-authored-by: ray chen --- .../templates/jobs/archetype-spec-gen-sdk.yml | 236 ---------------- .../stages/archetype-spec-gen-sdk.yml | 256 ++++++++++++++++++ 2 files changed, 256 insertions(+), 236 deletions(-) delete mode 100644 eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml create mode 100644 eng/common/pipelines/templates/stages/archetype-spec-gen-sdk.yml diff --git a/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml b/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml deleted file mode 100644 index 1b4d3376be89..000000000000 --- a/eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml +++ /dev/null @@ -1,236 +0,0 @@ -parameters: - - name: SpecRepoUrl - type: string - - name: SdkRepoUrl - type: string - - name: SpecRepoCommit - type: string - default: '$(Build.SourceBranch)' - - name: SdkRepoCommit - type: string - default: 'HEAD' - - name: ConfigType - type: string - values: - - 'TypeSpec' - - 'OpenAPI' - default: 'TypeSpec' - displayName: 'API specification type' - - name: ConfigPath - type: string - default: 'specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml' - displayName: 'Path to API specification file (TypeSpec/OpenAPI)' - - name: SkipPullRequestCreation - type: boolean - default: false - -jobs: -- job: - displayName: 'SDK Generation' - - variables: - - template: /eng/pipelines/templates/variables/image.yml - - name: NodeVersion - value: '22.13.x' - - name: PythonVersion - value: '3.13' - - name: SpecGenSdkVersion - value: 'latest' - - name: SdkArtifactName - value: SDK_Artifact - - pool: - name: $(LINUXPOOL) - vmImage: $(LINUXVMIMAGE) - - steps: - - checkout: none - - - pwsh: | - $tspConfigPathPattern = '^specification\/([^\/]+\/)+tspconfig\.yaml$' - $readmePathPattern = '^specification\/([^\/]+\/){2,}readme\.md$' - if (('${{ parameters.ConfigType }}' -eq 'TypeSpec') -and ('${{ parameters.ConfigPath }}' -notmatch $tspConfigPathPattern)) { - Write-Host "##vso[task.logissue type=error]'ConfigPath' must be a valid 'tspconfig.yaml' file path when 'ConfigType' is set to 'TypeSpec'. For example, 'specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml'" - Exit 1 - } elseif (('${{ parameters.ConfigType }}' -eq 'OpenAPI') -and ('${{ parameters.ConfigPath }}' -notmatch $readmePathPattern)) { - Write-Host "##vso[task.logissue type=error]'ConfigPath' must be a valid 'readme.md' file path when 'ConfigType' is set to 'OpenAPI'. For example, 'specification/appplatform/resource-manager/readme.md'" - Exit 1 - } - $urlPattern = '^https://github\.com/(?[^/]+)/(?[^/]+)' - if ('${{ parameters.SpecRepoUrl }}' -match $urlPattern) { - $specRepoOwner = $Matches['organization'] - Write-Host "##vso[task.setvariable variable=SpecRepoOwner]$specRepoOwner" - Write-Host "SpecRepoOwner variable set to: $specRepoOwner" - - $specRepoName = $Matches['repository'] - Write-Host "##vso[task.setvariable variable=SpecRepoName]$specRepoName" - Write-Host "SpecRepoName variable set to: $specRepoName" - - $specRepoDirectory = "$(System.DefaultWorkingDirectory)/$specRepoName" - Write-Host "##vso[task.setvariable variable=SpecRepoDirectory]$specRepoDirectory" - Write-Host "SpecRepoDirectory variable set to: $specRepoDirectory" - } - - if ('${{ parameters.SdkRepoUrl }}' -match $urlPattern) { - if ('${{ parameters.SpecRepoUrl }}'.EndsWith('-pr') -and (-not '${{ parameters.SdkRepoUrl }}'.EndsWith('-pr'))) { - Write-Host "##vso[task.logissue type=error]SdkRepoUrl must be a private repository if SpecRepoUrl is a private repository." - Exit 1 - } - - $sdkRepoOwner = $Matches['organization'] - Write-Host "##vso[task.setvariable variable=SdkRepoOwner]$sdkRepoOwner" - Write-Host "SdkRepoOwner variable set to: $sdkRepoOwner" - - $sdkRepoName = $Matches['repository'] - Write-Host "##vso[task.setvariable variable=SdkRepoName]$sdkRepoName" - Write-Host "SdkRepoName variable set to: $sdkRepoName" - - $sdkRepoDirectory = "$(System.DefaultWorkingDirectory)/$sdkRepoName" - Write-Host "##vso[task.setvariable variable=SdkRepoDirectory]$sdkRepoDirectory" - Write-Host "SdkRepoDirectory variable set to: $sdkRepoDirectory" - } - - if ([string]::IsNullOrEmpty($SpecRepoOwner) -or [string]::IsNullOrEmpty($SpecRepoName) -or [string]::IsNullOrEmpty($SdkRepoOwner) -or [string]::IsNullOrEmpty($SdkRepoName)) { - Write-Host "##vso[task.logissue type=error]One or more required variables is empty or invalid. Ensure that SpecRepoUrl and SdkRepoUrl are set to valid GitHub repository URLs." - Exit 1 - } - - displayName: "Create Run Time Variables" - - - template: /eng/common/pipelines/templates/steps/sparse-checkout.yml - parameters: - Paths: - - '/*' - - '!sdk/**/test-recordings/*' - - '!sdk/**/recordings/*' - - '!sdk/**/SessionRecords/*' - - '!sdk/**/session-records/*' - Repositories: - - Name: $(SpecRepoOwner)/$(SpecRepoName) - Commitish: ${{ parameters.SpecRepoCommit }} - WorkingDirectory: $(SpecRepoDirectory) - - Name: $(SdkRepoOwner)/$(SdkRepoName) - Commitish: ${{ parameters.SdkRepoCommit }} - WorkingDirectory: $(SdkRepoDirectory) - SkipCheckoutNone: true - - - script: | - if [ "${{ parameters.SpecRepoCommit }}" = "$(Build.SourceBranch)" ]; then - cd $(SpecRepoDirectory) - default_commit=$(git rev-parse HEAD) - echo "##vso[task.setvariable variable=SpecRepoCommit]$default_commit" - echo "SpecRepoCommit variable set to default commit: $default_commit" - else - echo "##vso[task.setvariable variable=SpecRepoCommit]${{ parameters.SpecRepoCommit }}" - echo "SpecRepoCommit variable set to: ${{ parameters.SpecRepoCommit }}" - fi - displayName: 'Set SpecRepoCommit variable' - - - task: NodeTool@0 - inputs: - versionSpec: $(NodeVersion) - displayName: 'Install Node.js' - - - task: UsePythonVersion@0 - inputs: - versionSpec: $(PythonVersion) - - - script: | - npm install -g @azure-tools/spec-gen-sdk@$(SpecGenSdkVersion) - displayName: 'Install spec-gen-sdk' - - - script: | - optional_params="" - sdk_gen_info="sdk generation from Config : " - - if [ "${{ parameters.ConfigType }}" = "TypeSpec" ]; then - optional_params="$optional_params --tsp-config-relative-path ${{ parameters.ConfigPath }}" - sdk_gen_info="$sdk_gen_info '${{ parameters.ConfigPath }}'," - else - optional_params="$optional_params --readme-relative-path ${{ parameters.ConfigPath }}" - sdk_gen_info="$sdk_gen_info '${{ parameters.ConfigPath }}'," - fi - - if [ "$(Build.Reason)" = "PullRequest" ]; then - optional_params="$optional_params --n=$(System.PullRequest.PullRequestNumber)" - specPrUrl="${{ parameters.SpecRepoUrl }}/pull/$(System.PullRequest.PullRequestNumber)" - sdk_gen_info="$sdk_gen_info spec PR: $specPrUrl" - fi - - sdk_gen_info="$sdk_gen_info and CommitSHA: '$(SpecRepoCommit)', in SpecRepo: '${{ parameters.SpecRepoUrl }}'" - echo "##vso[task.setvariable variable=GeneratedSDKInformation]$sdk_gen_info" - echo "Generated SDK Information : $sdk_gen_info" - - spec-gen-sdk \ - --scp "$(SpecRepoDirectory)" \ - --sdp "$(SdkRepoDirectory)" \ - --wf "$(System.DefaultWorkingDirectory)" \ - -l "$(SdkRepoName)" \ - -c "$(SpecRepoCommit)" \ - -t $true \ - $optional_params - displayName: 'Generate SDK' - - - task: PublishPipelineArtifact@1 - displayName: Publish SDK Artifact to Pipeline Artifacts - inputs: - artifactName: $(sdkArtifactName) - targetPath: "$(System.DefaultWorkingDirectory)/generatedSdkArtifacts" - - - task: PowerShell@2 - displayName: Add label to the spec PR - condition: and(eq(variables['Build.Reason'], 'PullRequest'), ne(variables['BreakingChangeLabel'], ''), eq(variables['BreakingChangeLabelAction'], 'add')) - inputs: - pwsh: true - workingDirectory: $(SdkRepoDirectory) - filePath: $(SdkRepoDirectory)/eng/common/scripts/Add-IssueLabels.ps1 - arguments: > - -RepoOwner $(SpecRepoOwner) - -RepoName $(SpecRepoName) - -IssueNumber "$(System.PullRequest.PullRequestNumber)" - -Labels $(BreakingChangeLabel) - -AuthToken "$(azuresdk-github-pat)" - - - task: PowerShell@2 - displayName: Remove label from the spec PR - condition: and(eq(variables['Build.Reason'], 'PullRequest'), ne(variables['BreakingChangeLabel'], ''), eq(variables['BreakingChangeLabelAction'], 'remove')) - inputs: - pwsh: true - workingDirectory: $(SdkRepoDirectory) - filePath: $(SdkRepoDirectory)/eng/common/scripts/Remove-IssueLabel.ps1 - arguments: > - -RepoOwner $(SpecRepoOwner) - -RepoName $(SpecRepoName) - -IssueNumber "$(System.PullRequest.PullRequestNumber)" - -LabelName $(BreakingChangeLabel) - -AuthToken "$(azuresdk-github-pat)" - - - ${{ if eq(parameters.SkipPullRequestCreation, false) }}: - - template: /eng/common/pipelines/templates/steps/git-push-changes.yml - parameters: - BaseRepoBranch: $(PrBranch)-$(Build.BuildId) - BaseRepoOwner: azure-sdk - CommitMsg: $(GeneratedSDKInformation) - TargetRepoOwner: $(SdkRepoOwner) - TargetRepoName: $(SdkRepoName) - PushArgs: "--force" - WorkingDirectory: $(SdkRepoDirectory) - ScriptDirectory: $(SdkRepoDirectory)/eng/common/scripts - - - task: PowerShell@2 - displayName: Create pull request - condition: and(succeeded(), eq(variables['HasChanges'], 'true'), ne(variables['Build.Reason'], 'PullRequest')) - inputs: - pwsh: true - workingDirectory: $(SdkRepoDirectory) - filePath: $(SdkRepoDirectory)/eng/common/scripts/Submit-PullRequest.ps1 - arguments: > - -RepoOwner "$(SdkRepoOwner)" - -RepoName "$(SdkRepoName)" - -BaseBranch "main" - -PROwner "azure-sdk" - -PRBranch "$(PrBranch)-$(Build.BuildId)" - -AuthToken "$(azuresdk-github-pat)" - -PRTitle "$(PrTitle)-generated-from-$(Build.DefinitionName)-$(Build.BuildId)" - -PRBody "$(GeneratedSDKInformation)" - -OpenAsDraft $true diff --git a/eng/common/pipelines/templates/stages/archetype-spec-gen-sdk.yml b/eng/common/pipelines/templates/stages/archetype-spec-gen-sdk.yml new file mode 100644 index 000000000000..f97b3c9c054c --- /dev/null +++ b/eng/common/pipelines/templates/stages/archetype-spec-gen-sdk.yml @@ -0,0 +1,256 @@ +parameters: + - name: SpecRepoUrl + type: string + - name: SdkRepoUrl + type: string + - name: SpecRepoCommit + type: string + default: '$(Build.SourceBranch)' + - name: SdkRepoCommit + type: string + default: 'HEAD' + - name: ConfigType + type: string + values: + - 'TypeSpec' + - 'OpenAPI' + default: 'TypeSpec' + displayName: 'API specification type' + - name: ConfigPath + type: string + default: 'specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml' + displayName: 'Path to API specification file (TypeSpec/OpenAPI)' + - name: SkipPullRequestCreation + type: boolean + default: false + +extends: + template: /eng/pipelines/templates/stages/1es-redirect.yml + parameters: + stages: + - stage: Build + displayName: 'SDK Generation' + jobs: + - job: + displayName: 'SDK Generation' + + variables: + - template: /eng/pipelines/templates/variables/image.yml + - name: NodeVersion + value: '22.13.x' + - name: PythonVersion + value: '3.13' + - name: SpecGenSdkVersion + value: 'latest' + - name: SdkArtifactName + value: SDK_Artifact + + pool: + name: $(LINUXPOOL) + vmImage: $(LINUXVMIMAGE) + os: linux + + templateContext: + outputParentDirectory: $(System.DefaultWorkingDirectory)/out + outputs: + - output: pipelineArtifact + displayName: Publish SDK artifacts to Pipeline Artifacts + condition: and(ne(variables['ValidationResult'], ''), eq(variables['HasSDKArtifact'], 'true')) + artifactName: $(sdkArtifactName) + targetPath: "$(System.DefaultWorkingDirectory)/out/generatedSdkArtifacts" + - output: pipelineArtifact + displayName: Publish API View artifacts to Pipeline Artifacts + condition: and(ne(variables['ValidationResult'], ''), eq(variables['HasApiViewArtifact'], 'true')) + artifactName: $(ArtifactName) + targetPath: "$(System.DefaultWorkingDirectory)/out/sdkApiViewArtifacts" + - output: pipelineArtifact + displayName: Publish logs to Pipeline Artifacts + condition: ne(variables['ValidationResult'], '') + artifactName: "spec-gen-sdk-logs" + targetPath: "$(System.DefaultWorkingDirectory)/out/logs" + + steps: + - checkout: none + + - pwsh: | + $tspConfigPathPattern = '^specification\/([^\/]+\/)+tspconfig\.yaml$' + $readmePathPattern = '^specification\/([^\/]+\/){2,}readme\.md$' + if (('${{ parameters.ConfigType }}' -eq 'TypeSpec') -and ('${{ parameters.ConfigPath }}' -notmatch $tspConfigPathPattern)) { + Write-Host "##vso[task.logissue type=error]'ConfigPath' must be a valid 'tspconfig.yaml' file path when 'ConfigType' is set to 'TypeSpec'. For example, 'specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml'" + Exit 1 + } elseif (('${{ parameters.ConfigType }}' -eq 'OpenAPI') -and ('${{ parameters.ConfigPath }}' -notmatch $readmePathPattern)) { + Write-Host "##vso[task.logissue type=error]'ConfigPath' must be a valid 'readme.md' file path when 'ConfigType' is set to 'OpenAPI'. For example, 'specification/appplatform/resource-manager/readme.md'" + Exit 1 + } + $urlPattern = '^https://github\.com/(?[^/]+)/(?[^/]+)' + if ('${{ parameters.SpecRepoUrl }}' -match $urlPattern) { + $specRepoOwner = $Matches['organization'] + Write-Host "##vso[task.setvariable variable=SpecRepoOwner]$specRepoOwner" + Write-Host "SpecRepoOwner variable set to: $specRepoOwner" + + $specRepoName = $Matches['repository'] + Write-Host "##vso[task.setvariable variable=SpecRepoName]$specRepoName" + Write-Host "SpecRepoName variable set to: $specRepoName" + + $specRepoDirectory = "$(System.DefaultWorkingDirectory)/$specRepoName" + Write-Host "##vso[task.setvariable variable=SpecRepoDirectory]$specRepoDirectory" + Write-Host "SpecRepoDirectory variable set to: $specRepoDirectory" + } + + if ('${{ parameters.SdkRepoUrl }}' -match $urlPattern) { + if ('${{ parameters.SpecRepoUrl }}'.EndsWith('-pr') -and (-not '${{ parameters.SdkRepoUrl }}'.EndsWith('-pr'))) { + Write-Host "##vso[task.logissue type=error]SdkRepoUrl must be a private repository if SpecRepoUrl is a private repository." + Exit 1 + } + + $sdkRepoOwner = $Matches['organization'] + Write-Host "##vso[task.setvariable variable=SdkRepoOwner]$sdkRepoOwner" + Write-Host "SdkRepoOwner variable set to: $sdkRepoOwner" + + $sdkRepoName = $Matches['repository'] + Write-Host "##vso[task.setvariable variable=SdkRepoName]$sdkRepoName" + Write-Host "SdkRepoName variable set to: $sdkRepoName" + + $sdkRepoDirectory = "$(System.DefaultWorkingDirectory)/$sdkRepoName" + Write-Host "##vso[task.setvariable variable=SdkRepoDirectory]$sdkRepoDirectory" + Write-Host "SdkRepoDirectory variable set to: $sdkRepoDirectory" + } + + if ([string]::IsNullOrEmpty($SpecRepoOwner) -or [string]::IsNullOrEmpty($SpecRepoName) -or [string]::IsNullOrEmpty($SdkRepoOwner) -or [string]::IsNullOrEmpty($SdkRepoName)) { + Write-Host "##vso[task.logissue type=error]One or more required variables is empty or invalid. Ensure that SpecRepoUrl and SdkRepoUrl are set to valid GitHub repository URLs." + Exit 1 + } + + displayName: "Create Run Time Variables" + + - template: /eng/common/pipelines/templates/steps/sparse-checkout.yml + parameters: + Paths: + - '/*' + - '!sdk/**/test-recordings/*' + - '!sdk/**/recordings/*' + - '!sdk/**/SessionRecords/*' + - '!sdk/**/session-records/*' + Repositories: + - Name: $(SpecRepoOwner)/$(SpecRepoName) + Commitish: ${{ parameters.SpecRepoCommit }} + WorkingDirectory: $(SpecRepoDirectory) + - Name: $(SdkRepoOwner)/$(SdkRepoName) + Commitish: ${{ parameters.SdkRepoCommit }} + WorkingDirectory: $(SdkRepoDirectory) + SkipCheckoutNone: true + + - script: | + if [ "${{ parameters.SpecRepoCommit }}" = "$(Build.SourceBranch)" ]; then + cd $(SpecRepoDirectory) + default_commit=$(git rev-parse HEAD) + echo "##vso[task.setvariable variable=SpecRepoCommit]$default_commit" + echo "SpecRepoCommit variable set to default commit: $default_commit" + else + echo "##vso[task.setvariable variable=SpecRepoCommit]${{ parameters.SpecRepoCommit }}" + echo "SpecRepoCommit variable set to: ${{ parameters.SpecRepoCommit }}" + fi + displayName: 'Set SpecRepoCommit variable' + + - task: NodeTool@0 + inputs: + versionSpec: $(NodeVersion) + displayName: 'Install Node.js' + + - task: UsePythonVersion@0 + inputs: + versionSpec: $(PythonVersion) + + - script: | + npm install -g @azure-tools/spec-gen-sdk@$(SpecGenSdkVersion) + displayName: 'Install spec-gen-sdk' + + - script: | + optional_params="" + sdk_gen_info="sdk generation from Config : " + + if [ "${{ parameters.ConfigType }}" = "TypeSpec" ]; then + optional_params="$optional_params --tsp-config-relative-path ${{ parameters.ConfigPath }}" + sdk_gen_info="$sdk_gen_info '${{ parameters.ConfigPath }}'," + else + optional_params="$optional_params --readme-relative-path ${{ parameters.ConfigPath }}" + sdk_gen_info="$sdk_gen_info '${{ parameters.ConfigPath }}'," + fi + + if [ "$(Build.Reason)" = "PullRequest" ]; then + optional_params="$optional_params --n=$(System.PullRequest.PullRequestNumber)" + specPrUrl="${{ parameters.SpecRepoUrl }}/pull/$(System.PullRequest.PullRequestNumber)" + sdk_gen_info="$sdk_gen_info spec PR: $specPrUrl" + fi + + sdk_gen_info="$sdk_gen_info and CommitSHA: '$(SpecRepoCommit)', in SpecRepo: '${{ parameters.SpecRepoUrl }}'" + echo "##vso[task.setvariable variable=GeneratedSDKInformation]$sdk_gen_info" + echo "Generated SDK Information : $sdk_gen_info" + + spec-gen-sdk \ + --scp "$(SpecRepoDirectory)" \ + --sdp "$(SdkRepoDirectory)" \ + --wf "$(System.DefaultWorkingDirectory)" \ + -l "$(SdkRepoName)" \ + -c "$(SpecRepoCommit)" \ + -t $true \ + $optional_params + displayName: 'Generate SDK' + + - task: PowerShell@2 + displayName: Add label to the spec PR + condition: and(eq(variables['Build.Reason'], 'PullRequest'), ne(variables['BreakingChangeLabel'], ''), eq(variables['BreakingChangeLabelAction'], 'add')) + inputs: + pwsh: true + workingDirectory: $(SdkRepoDirectory) + filePath: $(SdkRepoDirectory)/eng/common/scripts/Add-IssueLabels.ps1 + arguments: > + -RepoOwner $(SpecRepoOwner) + -RepoName $(SpecRepoName) + -IssueNumber "$(System.PullRequest.PullRequestNumber)" + -Labels $(BreakingChangeLabel) + -AuthToken "$(azuresdk-github-pat)" + + - task: PowerShell@2 + displayName: Remove label from the spec PR + condition: and(eq(variables['Build.Reason'], 'PullRequest'), ne(variables['BreakingChangeLabel'], ''), eq(variables['BreakingChangeLabelAction'], 'remove')) + inputs: + pwsh: true + workingDirectory: $(SdkRepoDirectory) + filePath: $(SdkRepoDirectory)/eng/common/scripts/Remove-IssueLabel.ps1 + arguments: > + -RepoOwner $(SpecRepoOwner) + -RepoName $(SpecRepoName) + -IssueNumber "$(System.PullRequest.PullRequestNumber)" + -LabelName $(BreakingChangeLabel) + -AuthToken "$(azuresdk-github-pat)" + + - ${{ if eq(parameters.SkipPullRequestCreation, false) }}: + - template: /eng/common/pipelines/templates/steps/git-push-changes.yml + parameters: + BaseRepoBranch: $(PrBranch)-$(Build.BuildId) + BaseRepoOwner: azure-sdk + CommitMsg: $(GeneratedSDKInformation) + TargetRepoOwner: $(SdkRepoOwner) + TargetRepoName: $(SdkRepoName) + PushArgs: "--force" + WorkingDirectory: $(SdkRepoDirectory) + ScriptDirectory: $(SdkRepoDirectory)/eng/common/scripts + + - task: PowerShell@2 + displayName: Create pull request + condition: and(succeeded(), eq(variables['HasChanges'], 'true'), ne(variables['Build.Reason'], 'PullRequest')) + inputs: + pwsh: true + workingDirectory: $(SdkRepoDirectory) + filePath: $(SdkRepoDirectory)/eng/common/scripts/Submit-PullRequest.ps1 + arguments: > + -RepoOwner "$(SdkRepoOwner)" + -RepoName "$(SdkRepoName)" + -BaseBranch "main" + -PROwner "azure-sdk" + -PRBranch "$(PrBranch)-$(Build.BuildId)" + -AuthToken "$(azuresdk-github-pat)" + -PRTitle "$(PrTitle)-generated-from-$(Build.DefinitionName)-$(Build.BuildId)" + -PRBody "$(GeneratedSDKInformation)" + -OpenAsDraft $true From 9910d7ad023175464cd6785ff37508e4f5b5729f Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Wed, 29 Jan 2025 15:02:04 -0800 Subject: [PATCH 67/74] Added 1es common template and updated default param values (#32364) * Added 1es common template and updated default param values * removed the invalid repo exclusion settings * remove disablment for sdl specific steps --- eng/pipelines/spec-gen-sdk.yml | 13 +++--- .../templates/stages/1es-redirect.yml | 42 +++++++++++++++++++ 2 files changed, 50 insertions(+), 5 deletions(-) create mode 100644 eng/pipelines/templates/stages/1es-redirect.yml diff --git a/eng/pipelines/spec-gen-sdk.yml b/eng/pipelines/spec-gen-sdk.yml index 5f8253b6887a..0737ce129bfd 100644 --- a/eng/pipelines/spec-gen-sdk.yml +++ b/eng/pipelines/spec-gen-sdk.yml @@ -1,10 +1,10 @@ parameters: - name: SpecRepoCommit type: string - default: 'HEAD' + default: '$(Build.SourceBranch)' - name: SdkRepoCommit type: string - default: 'HEAD' + default: 'main' - name: ConfigType type: string values: @@ -21,10 +21,13 @@ parameters: default: false trigger: none -pr: none +pr: + branches: + include: + - user/spec-gen-pipeline-testing extends: - template: /eng/common/pipelines/templates/jobs/archetype-spec-gen-sdk.yml + template: /eng/common/pipelines/templates/stages/archetype-spec-gen-sdk.yml parameters: SpecRepoUrl: 'https://github.com/$(Build.Repository.Name)' SdkRepoUrl: $(SdkRepoUrl) @@ -32,4 +35,4 @@ extends: SdkRepoCommit: ${{ parameters.SdkRepoCommit }} ConfigType: ${{ parameters.ConfigType }} ConfigPath: ${{ parameters.ConfigPath }} - SkipPullRequestCreation: ${{ parameters.SkipPullRequestCreation }} \ No newline at end of file + SkipPullRequestCreation: ${{ parameters.SkipPullRequestCreation }} diff --git a/eng/pipelines/templates/stages/1es-redirect.yml b/eng/pipelines/templates/stages/1es-redirect.yml new file mode 100644 index 000000000000..946690ec3603 --- /dev/null +++ b/eng/pipelines/templates/stages/1es-redirect.yml @@ -0,0 +1,42 @@ +resources: + repositories: + - repository: 1ESPipelineTemplates + type: git + name: 1ESPipelineTemplates/1ESPipelineTemplates + ref: refs/tags/release + +parameters: +- name: stages + type: stageList + default: [] +- name: Use1ESOfficial + type: boolean + default: true +- name: GenerateBaselines + type: boolean + default: false + +extends: + ${{ if and(parameters.Use1ESOfficial, eq(variables['System.TeamProject'], 'internal')) }}: + template: v1/1ES.Official.PipelineTemplate.yml@1ESPipelineTemplates + ${{ else }}: + template: v1/1ES.Unofficial.PipelineTemplate.yml@1ESPipelineTemplates + parameters: + settings: + skipBuildTagsForGitHubPullRequests: true + sdl: + ${{ if and(parameters.GenerateBaselines, eq(variables['Build.SourceBranchName'], 'main'), eq(variables['System.TeamProject'], 'internal')) }}: + autobaseline: + isMainPipeline: true + disableAutoBaselineOnNonDefaultBranches: true + enableForGitHub: true + sourceAnalysisPool: + name: azsdk-pool-mms-win-2022-general + image: azsdk-pool-mms-win-2022-1espt + os: windows + psscriptanalyzer: + compiled: true + break: true + policy: M365 + + stages: ${{ parameters.stages }} From 64d72d56ab79991e23cd3561afb19d366da446cb Mon Sep 17 00:00:00 2001 From: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Date: Wed, 29 Jan 2025 15:23:47 -0800 Subject: [PATCH 68/74] Sync eng/common directory with azure-sdk-tools for PR 9732 (#32393) * update emitter template * hide step if public pr * update conditions after testing --------- Co-authored-by: m-nash <64171366+m-nash@users.noreply.github.com> --- .../templates/archetype-typespec-emitter.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/eng/common/pipelines/templates/archetype-typespec-emitter.yml b/eng/common/pipelines/templates/archetype-typespec-emitter.yml index fd725b3bc7d5..85a292b8c323 100644 --- a/eng/common/pipelines/templates/archetype-typespec-emitter.yml +++ b/eng/common/pipelines/templates/archetype-typespec-emitter.yml @@ -447,3 +447,14 @@ extends: parameters: artifactName: test_artifacts_$(System.JobName) artifactPath: $(Build.ArtifactStagingDirectory) + + - ${{ if and(eq(variables['System.TeamProject'], 'internal'), ne(variables['Build.Reason'], 'PullRequest')) }}: + - task: AzureCLI@2 + displayName: "Upload Spector Standard Coverage Report" + condition: and(ne(variables['SpectorName'], ''), succeeded()) + inputs: + azureSubscription: "TypeSpec Storage" + scriptType: "bash" + scriptLocation: "inlineScript" + inlineScript: npx tsp-spector upload-coverage --coverageFile $(Build.ArtifactStagingDirectory)/tsp-spector-coverage-azure.json --generatorName @azure-typespec/$(SpectorName) --storageAccountName typespec --containerName coverages --generatorVersion $(node -p -e "require('./package.json').version") --generatorMode azure + workingDirectory: $(Build.SourcesDirectory)/eng/packages/$(SpectorName) From 709b609de15b7df6fac2b5796aecd3b3eaebd784 Mon Sep 17 00:00:00 2001 From: Albert Cheng <38804567+ckairen@users.noreply.github.com> Date: Wed, 29 Jan 2025 15:35:00 -0800 Subject: [PATCH 69/74] remove client tsp (#32389) --- eng/scripts/Create-APIView.ps1 | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/eng/scripts/Create-APIView.ps1 b/eng/scripts/Create-APIView.ps1 index e1bb0e15add1..9905ea14964a 100644 --- a/eng/scripts/Create-APIView.ps1 +++ b/eng/scripts/Create-APIView.ps1 @@ -99,15 +99,13 @@ function Get-ImpactedTypespecProjects { if ($configFilesInTypeSpecProjects) { foreach($configFilesInTypeSpecProject in $configFilesInTypeSpecProjects) { - $maintsp = Get-ChildItem -Path $($configFilesInTypeSpecProject.Directory.FullName) -File "main.tsp" - $clienttsp = Get-ChildItem -Path $($configFilesInTypeSpecProject.Directory.FullName) -File "client.tsp" - $entryPointFile = $maintsp ? $maintsp : $clienttsp + $entryPointFile = Get-ChildItem -Path $($configFilesInTypeSpecProject.Directory.FullName) -File "main.tsp" if ($entryPointFile) { Write-Host "Found $($configFilesInTypeSpecProject.Name) and $($entryPointFile.Name) in directory $($configFilesInTypeSpecProject.Directory.FullName)" return $configFilesInTypeSpecProject.Directory.FullName } else { - Write-Host "Did not find main.tsp nor client.tsp in directory $($configFilesInTypeSpecProject.Directory.FullName)" + Write-Host "Did not find main.tsp in directory $($configFilesInTypeSpecProject.Directory.FullName)" } } } From 61dfad755938173e9460644058433c9256cbc04d Mon Sep 17 00:00:00 2001 From: Jayati Tehri <72947097+jayati-tehri@users.noreply.github.com> Date: Wed, 29 Jan 2025 16:53:04 -0800 Subject: [PATCH 70/74] adding Missing property meterId (#32377) --- .../stable/2024-08-01/costmanagement.pricesheets.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2024-08-01/costmanagement.pricesheets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2024-08-01/costmanagement.pricesheets.json index e776aa981539..25d200119327 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2024-08-01/costmanagement.pricesheets.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2024-08-01/costmanagement.pricesheets.json @@ -335,6 +335,11 @@ "type": "string", "readOnly": true }, + "meterId": { + "description": "Unique identifier of the meter ", + "type": "string", + "readOnly": true + }, "meterName": { "description": "Name of the meter. The meter represents the deployable resource of an Azure service.", "type": "string", From fdfbd25830aa73101c5fdd85394c49a948e46e8b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 29 Jan 2025 18:03:32 -0800 Subject: [PATCH 71/74] Bump the typespec group across 1 directory with 2 updates (#32408) Bumps the typespec group with 2 updates in the / directory: [@azure-tools/typespec-client-generator-core](https://github.com/Azure/typespec-azure) and [@typespec/rest](https://github.com/microsoft/typespec). Updates `@azure-tools/typespec-client-generator-core` from 0.50.0 to 0.50.2 - [Release notes](https://github.com/Azure/typespec-azure/releases) - [Commits](https://github.com/Azure/typespec-azure/compare/typespec-azure@0.50.0...@azure-tools/typespec-client-generator-core@0.50.2) Updates `@typespec/rest` from 0.64.0 to 0.64.1 - [Release notes](https://github.com/microsoft/typespec/releases) - [Commits](https://github.com/microsoft/typespec/compare/typespec@0.64.0...@typespec/rest@0.64.1) --- updated-dependencies: - dependency-name: "@azure-tools/typespec-client-generator-core" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec - dependency-name: "@typespec/rest" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 33 ++++++++++++++++++++++++--------- package.json | 4 ++-- 2 files changed, 26 insertions(+), 11 deletions(-) diff --git a/package-lock.json b/package-lock.json index f1ffe4f00aa3..4e2721f5ea30 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@azure-tools/typespec-azure-resource-manager": "0.50.0", "@azure-tools/typespec-azure-rulesets": "0.50.0", "@azure-tools/typespec-client-generator-cli": "0.15.3", - "@azure-tools/typespec-client-generator-core": "0.50.0", + "@azure-tools/typespec-client-generator-core": "0.50.2", "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", "@typespec/compiler": "0.64.0", @@ -22,7 +22,7 @@ "@typespec/openapi": "0.64.0", "@typespec/openapi3": "0.64.0", "@typespec/prettier-plugin-typespec": "0.64.0", - "@typespec/rest": "0.64.0", + "@typespec/rest": "0.64.1", "@typespec/streams": "0.64.0", "@typespec/versioning": "0.64.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", @@ -836,9 +836,9 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.50.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.50.0.tgz", - "integrity": "sha512-Zk62SZb6W5neTtajcQAKll4zYSf3aKaMEDLymMTajXTsWxAlrb7sqnc8vTZWSIymaRI0A9olEL2luw9OLywUYA==", + "version": "0.50.2", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.50.2.tgz", + "integrity": "sha512-xSyJ5OWqu9BToUoQrmoN6a9pxHpTUqDEyc5pmhRwzeuz3zOIvFs2DFKimE2wqVmhFTYg6LTVqle/UU4sr/vdyQ==", "dev": true, "license": "MIT", "dependencies": { @@ -855,7 +855,8 @@ "@typespec/http": "~0.64.0", "@typespec/openapi": "~0.64.0", "@typespec/rest": "~0.64.0", - "@typespec/versioning": "~0.64.0" + "@typespec/versioning": "~0.64.0", + "@typespec/xml": "~0.64.0" } }, "node_modules/@azure-tools/typespec-client-generator-core/node_modules/yaml": { @@ -3599,9 +3600,9 @@ } }, "node_modules/@typespec/rest": { - "version": "0.64.0", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.64.0.tgz", - "integrity": "sha512-7+oUajQzOkZPTMtRiGp6hzTTmy7mRaxOYqxIPgDhYyr9I6oQPLAcBsYhFNk/ulcqld/ApaV5ycXaOlK41REOyQ==", + "version": "0.64.1", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.64.1.tgz", + "integrity": "sha512-DjN68PBch6XOvv8IQ7fRT6aj68akV8GaMLS7J8HGku5zX34dsQBPk+bwMfPlaBg7Y+vUdDyPnbuxvzMY+IKu/Q==", "dev": true, "license": "MIT", "engines": { @@ -3638,6 +3639,20 @@ "@typespec/compiler": "~0.64.0" } }, + "node_modules/@typespec/xml": { + "version": "0.64.0", + "resolved": "https://registry.npmjs.org/@typespec/xml/-/xml-0.64.0.tgz", + "integrity": "sha512-Sk+5S2C4YK+fqSadAlzRBSZbhvtDtxLQUS+vrYgiqzVS1F61nUmP7gQGUj+Kps7ncZSppPZystWJJnF7K34UJg==", + "dev": true, + "license": "MIT", + "peer": true, + "engines": { + "node": ">=18.0.0" + }, + "peerDependencies": { + "@typespec/compiler": "~0.64.0" + } + }, "node_modules/@vitest/expect": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.0.3.tgz", diff --git a/package.json b/package.json index e44503e5efed..3ab614459948 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "@azure-tools/typespec-azure-resource-manager": "0.50.0", "@azure-tools/typespec-azure-rulesets": "0.50.0", "@azure-tools/typespec-client-generator-cli": "0.15.3", - "@azure-tools/typespec-client-generator-core": "0.50.0", + "@azure-tools/typespec-client-generator-core": "0.50.2", "@azure-tools/typespec-liftr-base": "0.7.0", "@azure/avocado": "^0.9.1", "@autorest/openapi-to-typespec": "0.10.8", @@ -17,7 +17,7 @@ "@typespec/openapi": "0.64.0", "@typespec/openapi3": "0.64.0", "@typespec/prettier-plugin-typespec": "0.64.0", - "@typespec/rest": "0.64.0", + "@typespec/rest": "0.64.1", "@typespec/streams": "0.64.0", "@typespec/versioning": "0.64.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", From 81330ee21a8300ad377eacbaaf16efabb91d56c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= Date: Thu, 30 Jan 2025 10:58:34 +0000 Subject: [PATCH 72/74] [NetAppFiles]Release netapp microsoft.net app 2024 09 01 preview (#31808) * Copy files from preview/2024-07-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-09-01-preview Updated the API version from preview/2024-07-01-preview to preview/2024-09-01-preview. * Added tag for 2024-09-01-preview in readme file * prettier * from stable * update specs * remove stable * updating the operationId * remove filter --- .../examples/Accounts_ChangeKeyVault.json | 26 + .../examples/Accounts_CreateOrUpdate.json | 36 + .../examples/Accounts_CreateOrUpdateAD.json | 81 + .../examples/Accounts_Delete.json | 16 + .../examples/Accounts_Get.json | 36 + ...Accounts_GetChangeKeyVaultInformation.json | 15 + .../examples/Accounts_List.json | 24 + .../examples/Accounts_ListBySubscription.json | 23 + .../examples/Accounts_RenewCredentials.json | 17 + .../Accounts_TransitionEncryptionKey.json | 20 + .../examples/Accounts_Update.json | 46 + .../examples/BackupPolicies_Create.json | 51 + .../examples/BackupPolicies_Delete.json | 18 + .../examples/BackupPolicies_Get.json | 33 + .../examples/BackupPolicies_List.json | 29 + .../examples/BackupPolicies_Update.json | 70 + .../examples/BackupVaults_Create.json | 36 + .../examples/BackupVaults_Delete.json | 18 + .../examples/BackupVaults_Get.json | 25 + .../examples/BackupVaults_List.json | 28 + .../examples/BackupVaults_Update.json | 48 + .../examples/BackupsUnderAccount_Migrate.json | 19 + .../BackupsUnderBackupVault_Create.json | 50 + .../BackupsUnderBackupVault_Delete.json | 19 + .../examples/BackupsUnderBackupVault_Get.json | 29 + .../BackupsUnderBackupVault_List.json | 32 + ...upsUnderBackupVault_SingleFileRestore.json | 24 + .../BackupsUnderBackupVault_Update.json | 49 + .../examples/BackupsUnderVolume_Migrate.json | 21 + .../examples/CheckFilePathAvailability.json | 18 + .../examples/CheckNameAvailability.json | 19 + .../examples/CheckQuotaAvailability.json | 19 + .../examples/GroupIdListForLDAPUser.json | 29 + .../examples/NetworkSiblingSet_Query.json | 42 + .../examples/NetworkSiblingSet_Update.json | 49 + .../examples/OperationList.json | 1565 +++ .../examples/Pools_CreateOrUpdate.json | 51 + ...Pools_CreateOrUpdate_CustomThroughput.json | 54 + .../examples/Pools_Delete.json | 17 + .../examples/Pools_Get.json | 28 + .../examples/Pools_Get_CustomThroughput.json | 29 + .../examples/Pools_List.json | 47 + .../examples/Pools_Update.json | 34 + .../Pools_Update_CustomThroughput.json | 35 + .../examples/QuotaLimits_Get.json | 21 + .../examples/QuotaLimits_List.json | 87 + .../examples/RegionInfo.json | 20 + .../examples/RegionInfos_Get.json | 33 + .../examples/RegionInfos_List.json | 37 + .../examples/SnapshotPolicies_Create.json | 104 + .../examples/SnapshotPolicies_Delete.json | 18 + .../examples/SnapshotPolicies_Get.json | 44 + .../examples/SnapshotPolicies_List.json | 47 + .../SnapshotPolicies_ListVolumes.json | 36 + .../examples/SnapshotPolicies_Update.json | 107 + .../examples/Snapshots_Create.json | 31 + .../examples/Snapshots_Delete.json | 20 + .../examples/Snapshots_Get.json | 26 + .../examples/Snapshots_List.json | 29 + .../examples/Snapshots_SingleFileRestore.json | 25 + .../examples/Snapshots_Update.json | 32 + .../examples/Subvolumes_Create.json | 42 + .../examples/Subvolumes_Delete.json | 20 + .../examples/Subvolumes_Get.json | 24 + .../examples/Subvolumes_List.json | 28 + .../examples/Subvolumes_Metadata.json | 35 + .../examples/Subvolumes_Update.json | 34 + .../examples/VolumeGroups_Create_Oracle.json | 965 ++ .../examples/VolumeGroups_Create_SapHana.json | 406 + .../examples/VolumeGroups_Delete.json | 18 + .../examples/VolumeGroups_Get_Oracle.json | 510 + .../examples/VolumeGroups_Get_SapHana.json | 220 + .../examples/VolumeGroups_List_Oracle.json | 31 + .../examples/VolumeGroups_List_SapHana.json | 31 + .../examples/VolumeQuotaRules_Create.json | 52 + .../examples/VolumeQuotaRules_Delete.json | 20 + .../examples/VolumeQuotaRules_Get.json | 27 + .../examples/VolumeQuotaRules_List.json | 31 + .../examples/VolumeQuotaRules_Update.json | 37 + .../Volumes_AuthorizeExternalReplication.json | 23 + .../Volumes_AuthorizeReplication.json | 21 + .../examples/Volumes_BreakFileLocks.json | 22 + .../examples/Volumes_BreakReplication.json | 21 + .../examples/Volumes_CreateOrUpdate.json | 58 + .../examples/Volumes_Delete.json | 18 + .../examples/Volumes_DeleteReplication.json | 22 + .../Volumes_FinalizeExternalReplication.json | 17 + .../examples/Volumes_FinalizeRelocation.json | 22 + .../examples/Volumes_Get.json | 32 + .../examples/Volumes_LatestBackupStatus.json | 24 + .../examples/Volumes_LatestRestoreStatus.json | 22 + .../examples/Volumes_List.json | 35 + .../examples/Volumes_ListQuotaReport.json | 40 + .../examples/Volumes_ListReplications.json | 27 + .../examples/Volumes_PeerExternalCluster.json | 33 + .../Volumes_PerformReplicationTransfer.json | 21 + .../examples/Volumes_PoolChange.json | 21 + .../Volumes_PopulateAvailabilityZones.json | 37 + .../Volumes_ReInitializeReplication.json | 22 + .../Volumes_ReestablishReplication.json | 20 + .../examples/Volumes_Relocate.json | 19 + .../examples/Volumes_ReplicationStatus.json | 25 + .../examples/Volumes_ResetCifsPassword.json | 21 + .../examples/Volumes_ResyncReplication.json | 22 + .../examples/Volumes_Revert.json | 21 + .../examples/Volumes_RevertRelocation.json | 22 + .../examples/Volumes_SplitClone.json | 17 + .../examples/Volumes_Update.json | 43 + .../preview/2024-09-01-preview/netapp.json | 10770 ++++++++++++++++ .../netapp/resource-manager/readme.md | 10 + 110 files changed, 17751 insertions(+) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ChangeKeyVault.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdateAD.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ListBySubscription.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_RenewCredentials.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_TransitionEncryptionKey.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderAccount_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderVolume_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckFilePathAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckQuotaAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/GroupIdListForLDAPUser.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Query.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/OperationList.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate_CustomThroughput.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get_CustomThroughput.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update_CustomThroughput.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfo.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_ListVolumes.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Metadata.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakFileLocks.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_DeleteReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestBackupStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestRestoreStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListQuotaReport.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListReplications.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PeerExternalCluster.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PerformReplicationTransfer.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PoolChange.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PopulateAvailabilityZones.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReInitializeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReestablishReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Relocate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReplicationStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResetCifsPassword.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResyncReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Revert.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_RevertRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_SplitClone.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/netapp.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ChangeKeyVault.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ChangeKeyVault.json new file mode 100644 index 000000000000..c99d2310bbfe --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ChangeKeyVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": { + "keyVaultUri": "https://my-key-vault.managedhsm.azure.net", + "keyName": "rsakey", + "keyVaultResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "keyVaultPrivateEndpoints": [ + { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..b20b58ede166 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..52986713fe96 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": { + "activeDirectories": [ + { + "site": "SiteName", + "username": "ad_user_name", + "password": "ad_password", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..1ba69d7525dc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..df29b74766d7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "site": "SiteName", + "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", + "username": "ad_user_name", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json new file mode 100644 index 000000000000..dd0abf4cc709 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_List.json new file mode 100644 index 000000000000..38c40ce35cf9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ListBySubscription.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ListBySubscription.json new file mode 100644 index 000000000000..ecea22b6c58c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_ListBySubscription.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..e0f1572ebf21 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_TransitionEncryptionKey.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_TransitionEncryptionKey.json new file mode 100644 index 000000000000..6772f58d91da --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_TransitionEncryptionKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..2470bd8ad589 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-09-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..ec2366e0a9bb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01-preview", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..6cae11d9e8d9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..1256cf39ad83 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..580461b69b27 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1", + "name": "account1/backupPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..5beb5518bb76 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupPolicies_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-09-01-preview", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..75f0cbc03310 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..fed1a10a05bc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..77056a5e362e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_List.json new file mode 100644 index 000000000000..9eeddf4bb574 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..75cee5478aba --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupVaults_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01-preview", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..2896841cf39b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..856bae2a259b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01-preview", + "body": { + "properties": { + "label": "myLabel", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..5cc2eb57844b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..57c90c21487a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..9d3db6b36b3b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..0009292ee264 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01-preview", + "body": { + "fileList": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ], + "destinationVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..5d34de292c4e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderBackupVault_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..20aa31d1a09f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..3a15e5fee845 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview", + "body": { + "name": "my-exact-filepth", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..a5cc145fe17e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview", + "body": { + "name": "accName", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..d88434dfb44b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview", + "body": { + "name": "resource1", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..e2ca5560e9a9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/GroupIdListForLDAPUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "username": "user1" + } + }, + "responses": { + "200": { + "body": { + "groupIdsForLdapUser": [ + "123", + "224" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..858793b0e853 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..0cee17fd0426 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..8c2ed8c2402c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetApp/register/action", + "display": { + "provider": "Microsoft.NetApp", + "resource": "Subscription", + "operation": "Subscription Registration Action", + "description": "Subscription Registration Action" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume resource", + "description": "Reads a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write volume resource", + "description": "Writes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete volume resource", + "description": "Deletes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/Revert/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert volume resource", + "description": "Revert volume to specific snapshot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BreakReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Break volume replication resource", + "description": "Break volume replication relations" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ListReplications/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReInitializeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Re-Initialize replication", + "description": "Attempts to re-initialize an uninitialized replication" + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AverageReadLatency", + "displayName": "Average read latency", + "displayDescription": "Average read latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageReadLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "AverageWriteLatency", + "displayName": "Average write latency", + "displayDescription": "Average write latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageWriteLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeLogicalSize", + "displayName": "Volume Consumed Size", + "displayDescription": "Logical size of the volume (used bytes)", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeSnapshotSize", + "displayName": "Volume snapshot size", + "displayDescription": "Size of all snapshots in volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadIops", + "displayName": "Read iops", + "displayDescription": "Read In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteIops", + "displayName": "Write iops", + "displayDescription": "Write In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeAllocatedSize", + "displayName": "Volume allocated size", + "displayDescription": "The provisioned size of a volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierSize", + "displayName": "Volume cool tier size", + "displayDescription": "Volume Footprint for Cool Tier", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataReadSize", + "displayName": "Volume cool tier data read size", + "displayDescription": "Data read in using GET per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataReadSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataWriteSize", + "displayName": "Volume cool tier data write size", + "displayDescription": "Data tiered out using PUT per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataWriteSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferDuration", + "displayName": "Volume replication last transfer duration", + "displayDescription": "The amount of time in seconds it took for the last transfer to complete.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferDuration", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferSize", + "displayName": "Volume replication last transfer size", + "displayDescription": "The total number of bytes transferred as part of the last transfer.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationHealthy", + "displayName": "Is volume replication status healthy", + "displayDescription": "Condition of the relationship, 1 or 0.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationHealthy", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLagTime", + "displayName": "Volume replication lag time", + "displayDescription": "The amount of time in seconds by which the data on the mirror lags behind the source.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLagTime", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationTotalTransferBytes", + "displayName": "Volume replication total transfer", + "displayDescription": "Cumulative bytes transferred for the relationship.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationTotalTransferBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipProgress", + "displayName": "Volume replication progress", + "displayDescription": "Total amount of data transferred for the current transfer operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipProgress", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipTransferring", + "displayName": "Is volume replication transferring", + "displayDescription": "Whether the status of the Volume Replication is 'transferring'.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipTransferring", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeLogicalBackupBytes", + "displayName": "Volume Backup Bytes", + "displayDescription": "Total bytes backed up for this Volume.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeLogicalBackupBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeProtected", + "displayName": "Is Volume Backup Enabled", + "displayDescription": "Is backup enabled for the volume? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeProtected", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeBackupActive", + "displayName": "Is Volume Backup suspended", + "displayDescription": "Is the backup policy suspended for the volume? 0 if yes, 1 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeBackupActive", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationTransferredBytes", + "displayName": "Volume Backup Last Transferred Bytes", + "displayDescription": "Total bytes transferred for last backup or restore operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationTransferredBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationComplete", + "displayName": "Is Volume Backup Operation Complete", + "displayDescription": "Did the last volume backup or restore operation complete successfully? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationComplete", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeConsumedSizePercentage", + "displayName": "Percentage Volume Consumed Size", + "displayDescription": "The percentage of the volume consumed including snapshots.", + "unit": "Percent", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeConsumedSizePercentage", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "OtherThroughput", + "displayName": "Other throughput", + "displayDescription": "Other throughput (that is not read or write) in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "OtherThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadThroughput", + "displayName": "Read throughput", + "displayDescription": "Read throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "TotalThroughput", + "displayName": "Total throughput", + "displayDescription": "Sum of all throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "TotalThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteThroughput", + "displayName": "Write throughput", + "displayDescription": "Write throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/AuthorizeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Authorize Replication", + "description": "Authorize the source volume replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ResyncReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Resync Replication", + "description": "Resync the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/DeleteReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete Replication", + "description": "Delete the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/MountTargets/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read mount target resource", + "description": "Reads a mount target resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BackupStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RestoreStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/PoolChange/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Change pool for volume", + "description": "Moves volume to another pool." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RelocateVolume/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Relocate volume to a new stamp.", + "description": "Relocate volume to a new stamp." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/FinalizeRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Finalize relocation of volume.", + "description": "Finalize relocation by cleaning up the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RevertRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert the relocation of volume.", + "description": "Revert the relocation and revert back to the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Read account resource", + "description": "Reads an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Write account resource", + "description": "Writes an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Delete account resource", + "description": "Deletes a account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/RenewCredentials/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Renew MSI credentials, if possible.", + "description": "Renews MSI credentials of account, if account has MSI credentials that are due for renewal." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read pool resource", + "description": "Reads a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write pool resource", + "description": "Writes a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Delete pool resource", + "description": "Deletes a pool resource." + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "VolumePoolAllocatedUsed", + "displayName": "Pool Allocated To Volume Size", + "displayDescription": "Allocated used size of the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedUsed", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalLogicalSize", + "displayName": "Pool Consumed Size", + "displayDescription": "Sum of the logical size of all the volumes belonging to the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedSize", + "displayName": "Pool Allocated Size", + "displayDescription": "Provisioned size of this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalSnapshotSize", + "displayName": "Total Snapshot size for the pool", + "displayDescription": "Sum of snapshot size of all volumes in this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolProvisionedThroughput", + "displayName": "Provisioned throughput for the pool", + "displayDescription": "Provisioned throughput of this pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolProvisionedThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedToVolumeThroughput", + "displayName": "Pool allocated throughput", + "displayDescription": "Sum of the throughput of all the volumes belonging to the pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedToVolumeThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Autoscale", + "displayName": "Capacity Pool Autoscaled" + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read log definitions.", + "description": "Gets the log definitions for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Read snapshot resource", + "description": "Reads a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Write snapshot resource", + "description": "Writes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Delete snapshot resource", + "description": "Deletes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/RestoreFiles/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Single File Snapshot Restore", + "description": "Restores files from a snapshot resource" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Write subvolume Resource", + "description": "Write a subvolume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/GetMetadata/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Subvolume Metadata resource.", + "description": "Read subvolume metadata resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Read snapshot policy resource", + "description": "Reads a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Write snapshot policy resource", + "description": "Writes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Delete snapshot policy resource", + "description": "Deletes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/Volumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/ListVolumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Read backup resource.", + "description": "Reads a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Write backup resource.", + "description": "Writes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Delete backup resource", + "description": "Deletes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Read backup policy resource.", + "description": "Reads a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Write backup policy resource.", + "description": "Writes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Delete backup policy resource", + "description": "Deletes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/vaults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Vault resource type", + "operation": "Read vault resource.", + "description": "Reads a vault resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Read an account backup resource.", + "description": "Reads an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Write an account backup resource.", + "description": "Writes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Delete an account backup resource.", + "description": "Deletes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Read volume group resource", + "description": "Reads a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Write volume group resource", + "description": "Writes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Delete volume group resource", + "description": "Deletes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/quotaLimits/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "QuotaLimit resource type", + "operation": "Read QuotaLimit resource type", + "description": "Reads a Quotalimit resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/Operations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operations resource type", + "operation": "Read operation resource", + "description": "Reads an operation resources." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/operationresults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operation results resource type", + "operation": "Read operation result resource", + "description": "Reads an operation result resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Location wide operation", + "operation": "Read location wide operation", + "description": "Reads a location wide operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checknameavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "NetApp resources", + "operation": "Check if resource name is available", + "description": "Check if resource name is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkfilepathavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Check if file path is available", + "description": "Check if file path is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/unregister/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subscription", + "operation": "Unregister Subscription for Azure NetApp Files", + "description": "Unregisters Subscription with Microsoft.NetApp resource provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkinventory/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "ReservedCapacity reservation resource.", + "operation": "Checks ReservedCapacity inventory.", + "description": "Checks ReservedCapacity inventory." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..2b8158a5c318 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Premium", + "qosType": "Auto" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate_CustomThroughput.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate_CustomThroughput.json new file mode 100644 index 000000000000..0b969115fb09 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_CreateOrUpdate_CustomThroughput.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "customPool1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Flexible", + "qosType": "Manual", + "customThroughputMibps": 128 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1", + "name": "account1/customPool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Flexible", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 128, + "customThroughputMibps": 128 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1", + "name": "account1/customPool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Flexible", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 128, + "customThroughputMibps": 128 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..4cc90b3a9486 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..f9be68e5e29f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get_CustomThroughput.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get_CustomThroughput.json new file mode 100644 index 000000000000..22f7260e44a5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Get_CustomThroughput.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "customPool1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1", + "name": "account1/customPool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Flexible", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 128, + "utilizedThroughputMibps": 100.47, + "customThroughputMibps": 128 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..e8178028a946 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1", + "name": "account1/customPool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Flexible", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 128, + "customThroughputMibps": 128, + "utilizedThroughputMibps": 100.47 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update.json new file mode 100644 index 000000000000..de1fda479b0f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update_CustomThroughput.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update_CustomThroughput.json new file mode 100644 index 000000000000..007b54688710 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Pools_Update_CustomThroughput.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "customPool1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/customPool1", + "name": "account1/customPool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Flexible", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 128, + "utilizedThroughputMibps": 100.47, + "customThroughputMibps": 128 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..03249c5353e0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..4f768ca61360 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/accountsPerSubscription", + "name": "eastus/accountsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/poolsPerAccount", + "name": "eastus/poolsPerAccount", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 25, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/volumesPerPool", + "name": "eastus/volumesPerPool", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/snapshotsPerVolume", + "name": "eastus/snapshotsPerVolume", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 255, + "default": 255 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalTiBsPerSubscription", + "name": "eastus/totalTiBsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 1000, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalDPVolumesPerSubscription", + "name": "eastus/totalDPVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalVolumesPerSubscription", + "name": "eastus/totalVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfo.json new file mode 100644 index 000000000000..68f775b78b76 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..7dca6050474f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_List.json new file mode 100644 index 000000000000..869be47620b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..7cdbb5fc9ae7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..20bba13b10ad --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..f23d878a1a4d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..108b37201efe --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "location": "eastus", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..567032a0c90a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..df59b5da5582 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-09-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Create.json new file mode 100644 index 000000000000..61292e58c493 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Create.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01-preview", + "location": "eastus", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..ac5dd1da3dee --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Get.json new file mode 100644 index 000000000000..b47a00c9f3e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_List.json new file mode 100644 index 000000000000..a7e29ae8d7df --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..db5d67e1a708 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_SingleFileRestore.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01-preview", + "body": { + "filePaths": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Update.json new file mode 100644 index 000000000000..9c3e4cc0f22d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Snapshots_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..1a4674579087 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01-preview", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Succeeded", + "size": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..a1e0a2ed1bea --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..ff9056e02ac5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_List.json new file mode 100644 index 000000000000..664846d090c0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..85da5480889f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Metadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata", + "name": "account1/pool1/volume1/subvolume1/metadata", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata", + "properties": { + "path": "/pathToSubvol", + "size": 5, + "bytesUsed": 5, + "permissions": "777", + "creationTimeStamp": "2017-08-15T13:23:33Z", + "accessedTimeStamp": "2017-08-15T13:23:33Z", + "modifiedTimeStamp": "2017-08-15T13:23:33Z", + "changedTimeStamp": "2017-08-15T13:23:33Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..f489ee8bd0e3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Subvolumes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-09-01-preview", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1", + "properties": { + "path": "/subvolumePath", + "size": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..3f53e43ebac7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_Oracle.json @@ -0,0 +1,965 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01-preview", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data1", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data1", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data2", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data2", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data3", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data3", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data4", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data4", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data5", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data5", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data6", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data6", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data7", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data7", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data8", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data8", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log-mirror", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log-mirror", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-binary", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-binary", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..8902cd2038e6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Create_SapHana.json @@ -0,0 +1,406 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01-preview", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "name": "test-data-mnt00001", + "properties": { + "creationToken": "test-data-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-mnt00001", + "properties": { + "creationToken": "test-log-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-shared", + "properties": { + "creationToken": "test-shared", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "shared", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-data-backup", + "properties": { + "creationToken": "test-data-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-backup", + "properties": { + "creationToken": "test-log-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-shared", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..2da4d53c1205 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..fad9b4e00200 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_Oracle.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2", + "volumesCount": 12 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..966e7c49d93e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_Get_SapHana.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-shared", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..f3bc9f11512a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "DEV", + "volumesCount": 12 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..a3dee78e06e3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..550e2e25186e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01-preview", + "body": { + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Creating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..34035699e99c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..49a31227eae9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..7239ed235fa7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..94e73714224f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/VolumeQuotaRules_Update.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-09-01-preview", + "body": { + "properties": { + "quotaSizeInKiBs": 100009 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "provisioningState": "Patching", + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeExternalReplication.json new file mode 100644 index 000000000000..ea60c358d2af --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeExternalReplication.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "svmPeeringCommand": "vserver peer accept -vserver OnPremSvm -peer-vserver AnfSvm" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..473782fb8ece --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..1488925e1fcc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakFileLocks.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "clientIp": "101.102.103.104", + "confirmRunningDisruptiveOperation": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..e0219e1181c1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_BreakReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..1c33acb9dd65 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": { + "creationToken": "my-unique-file-path", + "serviceLevel": "Premium", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..9c8518d8d23d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..ea8035aaf5e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_DeleteReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeExternalReplication.json new file mode 100644 index 000000000000..fdaf31c99c0b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeExternalReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..b4acf24ccab2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_FinalizeRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..ebb9ef47d00b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..0f28b9d097a5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestBackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..f96407a10fad --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_LatestRestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_List.json new file mode 100644 index 000000000000..3d2a5581dbab --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListQuotaReport.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListQuotaReport.json new file mode 100644 index 000000000000..111d35dc82a4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListQuotaReport.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "quotaType": "IndividualUserQuota", + "quotaTarget": "1013", + "quotaLimitTotalInKiBs": 204914688, + "quotaLimitUsedInKiBs": 8192, + "percentageUsed": 5.0, + "isDerivedQuota": false + }, + { + "quotaType": "IndividualGroupQuota", + "quotaTarget": "1012", + "quotaLimitTotalInKiBs": 204914688, + "quotaLimitUsedInKiBs": 8192, + "percentageUsed": 5.0, + "isDerivedQuota": false + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..e3f304721aef --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ListReplications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "replicationSchedule": "daily", + "remoteVolumeResourceId": "/subscriptions/36e85c76-e720-473e-881f-e2fe72f462d0/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-5999/capacityPools/pool-0977/volumes/volume-4508", + "remoteVolumeRegion": "westus" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PeerExternalCluster.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PeerExternalCluster.json new file mode 100644 index 000000000000..215fd1ea7c6e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PeerExternalCluster.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "peerIpAddresses": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ] + } + }, + "responses": { + "200": { + "body": { + "peerAcceptCommand": "cluster peer create -ipspace replication -encryption-protocol-proposed tls-psk -passphrase passphraseString -peer-addrs 1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4,1.1.1.5,1.1.1.6" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..ea194eb6bae3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PerformReplicationTransfer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..95bac2bd5c5b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PoolChange.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..6982bea9d845 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_PopulateAvailabilityZones.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..ea8035aaf5e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..bee5addda63c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReestablishReplication.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "sourceVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..d57774e2c5d0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Relocate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..56617fcf87f5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ReplicationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "totalProgress": "1048576", + "errorMessage": "" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..ea194eb6bae3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..ea8035aaf5e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_ResyncReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Revert.json new file mode 100644 index 000000000000..65baee3a7d57 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Revert.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..ea8035aaf5e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_RevertRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_SplitClone.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_SplitClone.json new file mode 100644 index 000000000000..fdaf31c99c0b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_SplitClone.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Update.json new file mode 100644 index 000000000000..ce603960b608 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/examples/Volumes_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-09-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/netapp.json new file mode 100644 index 000000000000..fbb955027e3e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-09-01-preview/netapp.json @@ -0,0 +1,10770 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-09-01-preview", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/transitiontocmk": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_TransitionToCmk", + "summary": "Transition volumes encryption from PMK to CMK.", + "description": "Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption transition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/encryptionTransitionRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_MigrateEncryptionKey": { + "$ref": "examples/Accounts_TransitionEncryptionKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_GetKeyVaultStatus", + "summary": "Get information about how volumes under NetApp account are encrypted.", + "description": "Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_GetChangeKeyVaultInformation": { + "$ref": "examples/Accounts_GetChangeKeyVaultInformation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ChangeKeyVault", + "summary": "Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account.", + "description": "Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption migration.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/changeKeyVault" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_ChangeKeyVault": { + "$ref": "examples/Accounts_ChangeKeyVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + }, + "Pools_Get_CustomThroughput": { + "$ref": "examples/Pools_Get_CustomThroughput.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + }, + "Pools_CreateOrUpdate_CustomThroughput": { + "$ref": "examples/Pools_CreateOrUpdate_CustomThroughput.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + }, + "Pools_Update_CustomThroughput": { + "$ref": "examples/Pools_Update_CustomThroughput.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent": { + "post": { + "tags": [ + "Split clone volume" + ], + "summary": "Split clone from parent volume", + "description": " Split operation to convert clone volume to an independent volume.", + "operationId": "Volumes_SplitCloneFromParent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_SplitClone": { + "$ref": "examples/Volumes_SplitClone.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listQuotaReport": { + "post": { + "tags": [ + "Quota Report for Volume" + ], + "summary": "Lists Quota Report for the volume", + "description": "Returns report of quotas for the volume", + "operationId": "Volumes_ListQuotaReport", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listQuotaReportResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/listQuotaReportResponse" + }, + "x-ms-examples": { + "ListQuotaReport": { + "$ref": "examples/Volumes_ListQuotaReport.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster": { + "post": { + "summary": "Start Cluster peering", + "description": "Starts peering the external cluster for this migration volume", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_PeerExternalCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Cluster peer request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/peerClusterForVolumeMigrationRequest" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/clusterPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_PeerExternalCluster": { + "$ref": "examples/Volumes_PeerExternalCluster.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/clusterPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeExternalReplication": { + "post": { + "summary": "Start migration process", + "description": "Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_AuthorizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/svmPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_AuthorizeExternalReplication": { + "$ref": "examples/Volumes_AuthorizeExternalReplication.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/svmPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication": { + "post": { + "summary": "Finalize migration process", + "description": "Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.", + "tags": [ + "Volumes OnPrem Migration Finalize" + ], + "operationId": "Volumes_FinalizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_FinalizeExternalReplication": { + "$ref": "examples/Volumes_FinalizeExternalReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer": { + "post": { + "tags": [ + "Volumes OnPrem Migration" + ], + "summary": "Perform a replication transfer", + "description": "Performs an adhoc replication transfer on a volume with volumeType Migration", + "operationId": "Volumes_PerformReplicationTransfer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PerformReplicationTransfer": { + "$ref": "examples/Volumes_PerformReplicationTransfer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "availabilityZone": { + "title": "Logical availability zone", + "type": "string", + "example": "1", + "x-nullable": true, + "description": "The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed." + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + }, + "nfsV4IDDomain": { + "type": "string", + "description": "Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.", + "maxLength": 255, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9.-]{0,253}[a-zA-Z0-9]$", + "x-nullable": true, + "example": "defaultv4IDDomain.com" + }, + "isMultiAdEnabled": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "This will have true value only if account is Multiple AD enabled." + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + }, + "federatedClientId": { + "type": "string", + "description": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults.", + "example": "87654321-1234-1234-1234-876543214321" + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "customThroughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level", + "type": "number", + "x-nullable": true, + "example": 128 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "customThroughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this pool and this will be accepted as input only for manual qosType pool with Flexible service level", + "type": "number", + "x-nullable": true, + "example": 128 + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 1PiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + } + ] + }, + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups" + } + ] + }, + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "The original value of the network features type available to the volume at the time it was created.", + "example": "Basic" + }, + "effectiveNetworkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "The effective value of the network features type available to the volume, or current effective state of update.", + "readOnly": true, + "example": "Standard" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "acceptGrowCapacityPoolForShortTermCloneSplit": { + "title": "acceptGrowCapacityPoolForShortTermCloneSplit", + "type": "string", + "description": "While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Accepted", + "Declined" + ], + "x-ms-enum": { + "name": "acceptGrowCapacityPoolForShortTermCloneSplit", + "modelAsString": true, + "values": [ + { + "value": "Accepted", + "description": "Auto grow capacity pool for short term clone split is accepted." + }, + { + "value": "Declined", + "description": "Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool." + } + ] + }, + "example": "Accepted" + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "coolAccessTieringPolicy": { + "$ref": "#/definitions/coolAccessTieringPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + }, + "inheritedSizeInBytes": { + "title": "inheritedSizeInBytes", + "type": "integer", + "format": "int64", + "description": "Space shared by short term clone volume with parent volume in bytes.", + "readOnly": true, + "x-nullable": true + }, + "language": { + "title": "language", + "$ref": "#/definitions/VolumeLanguage" + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume. Required for cross region and cross zone replication", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + }, + "destinationReplications": { + "description": "A list of destination replications", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/destinationReplication" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a ONTAP Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the ONTAP Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the replication.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8" + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "destinationReplication": { + "description": "Destination replication properties", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + }, + "description": "The resource ID of the remote volume" + }, + "replicationType": { + "type": "string", + "description": "Indicates whether the replication is cross zone or cross region.", + "enum": [ + "CrossRegionReplication", + "CrossZoneReplication" + ], + "x-ms-enum": { + "name": "ReplicationType", + "modelAsString": true, + "values": [ + { + "value": "CrossRegionReplication", + "description": "Cross region replication" + }, + { + "value": "CrossZoneReplication", + "description": "Cross zone replication" + } + ] + } + }, + "region": { + "type": "string", + "description": "The remote region for the destination volume." + }, + "zone": { + "type": "string", + "description": "The remote zone for the destination volume." + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 1PiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "coolAccessTieringPolicy": { + "$ref": "#/definitions/coolAccessTieringPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + } + ] + } + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy GUID ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "listQuotaReportResponse": { + "description": "Quota Report for volume", + "type": "object", + "properties": { + "value": { + "description": "List of volume quota report records", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/quotaReport" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "quotaReport": { + "description": "Quota report record properties", + "type": "object", + "properties": { + "quotaType": { + "description": "Type of quota", + "$ref": "#/definitions/quotaType" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ", + "example": "1001" + }, + "quotaLimitUsedInKiBs": { + "type": "integer", + "description": "Specifies the current usage in kibibytes for the user/group quota.", + "format": "int64", + "example": 1024 + }, + "quotaLimitTotalInKiBs": { + "type": "integer", + "description": "Specifies the total size limit in kibibytes for the user/group quota.", + "format": "int64", + "example": 1024 + }, + "percentageUsed": { + "type": "number", + "description": "Percentage of used size compared to total size.", + "example": 10.0 + }, + "isDerivedQuota": { + "title": "IsDerivedQuota", + "type": "boolean", + "description": "Flag to indicate whether the quota is derived from default quota.", + "example": true + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS", + "Flexible" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + }, + { + "value": "Flexible", + "description": "Flexible service level" + } + ] + } + }, + "VolumeLanguage": { + "title": "VolumeLanguage", + "type": "string", + "x-nullable": true, + "description": "Language supported for volume.", + "enum": [ + "c.utf-8", + "utf8mb4", + "ar", + "ar.utf-8", + "hr", + "hr.utf-8", + "cs", + "cs.utf-8", + "da", + "da.utf-8", + "nl", + "nl.utf-8", + "en", + "en.utf-8", + "fi", + "fi.utf-8", + "fr", + "fr.utf-8", + "de", + "de.utf-8", + "he", + "he.utf-8", + "hu", + "hu.utf-8", + "it", + "it.utf-8", + "ja", + "ja.utf-8", + "ja-v1", + "ja-v1.utf-8", + "ja-jp.pck", + "ja-jp.pck.utf-8", + "ja-jp.932", + "ja-jp.932.utf-8", + "ja-jp.pck-v2", + "ja-jp.pck-v2.utf-8", + "ko", + "ko.utf-8", + "no", + "no.utf-8", + "pl", + "pl.utf-8", + "pt", + "pt.utf-8", + "c", + "ro", + "ro.utf-8", + "ru", + "ru.utf-8", + "zh", + "zh.utf-8", + "zh.gbk", + "zh.gbk.utf-8", + "zh-tw.big5", + "zh-tw.big5.utf-8", + "zh-tw", + "zh-tw.utf-8", + "sk", + "sk.utf-8", + "sl", + "sl.utf-8", + "es", + "es.utf-8", + "sv", + "sv.utf-8", + "tr", + "tr.utf-8", + "en-us", + "en-us.utf-8" + ], + "x-ms-enum": { + "name": "VolumeLanguage", + "modelAsString": true, + "values": [ + { + "value": "c.utf-8", + "description": "Posix with UTF-8" + }, + { + "value": "utf8mb4", + "description": "UTF-8 with 4 byte character support" + }, + { + "value": "ar", + "description": "Arabic - Deprecated" + }, + { + "value": "ar.utf-8", + "description": "Arabic with UTF-8" + }, + { + "value": "hr", + "description": "Croatian - Deprecated" + }, + { + "value": "hr.utf-8", + "description": "Croatian with UTF-8" + }, + { + "value": "cs", + "description": "Czech - Deprecated" + }, + { + "value": "cs.utf-8", + "description": "Czech with UTF-8" + }, + { + "value": "da", + "description": "Danish - Deprecated" + }, + { + "value": "da.utf-8", + "description": "Danish with UTF-8" + }, + { + "value": "nl", + "description": "Dutch - Deprecated" + }, + { + "value": "nl.utf-8", + "description": "Dutch with UTF-8" + }, + { + "value": "en", + "description": "English - Deprecated" + }, + { + "value": "en.utf-8", + "description": "English with UTF-8" + }, + { + "value": "fi", + "description": "Finnish - Deprecated" + }, + { + "value": "fi.utf-8", + "description": "Finnish with UTF-8" + }, + { + "value": "fr", + "description": "French - Deprecated" + }, + { + "value": "fr.utf-8", + "description": "French with UTF-8" + }, + { + "value": "de", + "description": "German - Deprecated" + }, + { + "value": "de.utf-8", + "description": "German with UTF-8" + }, + { + "value": "he", + "description": "Hebrew - Deprecated" + }, + { + "value": "he.utf-8", + "description": "Hebrew with UTF-8" + }, + { + "value": "hu", + "description": "Hungarian - Deprecated" + }, + { + "value": "hu.utf-8", + "description": "Hungarian with UTF-8" + }, + { + "value": "it", + "description": "Italian - Deprecated" + }, + { + "value": "it.utf-8", + "description": "Italian with UTF-8" + }, + { + "value": "ja", + "description": "Japanese euc-j - Deprecated" + }, + { + "value": "ja.utf-8", + "description": "Japanese euc-j with UTF-8" + }, + { + "value": "ja-v1", + "description": "Japanese euc-j - Deprecated" + }, + { + "value": "ja-v1.utf-8", + "description": "Japanese euc-j with UTF-8" + }, + { + "value": "ja-jp.pck", + "description": "Japanese pck" + }, + { + "value": "ja-jp.pck.utf-8", + "description": "Japanese pck with UTF-8 - Deprecated" + }, + { + "value": "ja-jp.932", + "description": "Japanese cp932" + }, + { + "value": "ja-jp.932.utf-8", + "description": "Japanese cp932 with UTF-8 - Deprecated" + }, + { + "value": "ja-jp.pck-v2", + "description": "Japanese pck - sjis" + }, + { + "value": "ja-jp.pck-v2.utf-8", + "description": "Japanese pck - sjis with UTF-8 - Deprecated" + }, + { + "value": "ko", + "description": "Korean - Deprecated" + }, + { + "value": "ko.utf-8", + "description": "Korean with UTF-8" + }, + { + "value": "no", + "description": "Norwegian - Deprecated" + }, + { + "value": "no.utf-8", + "description": "Norwegian with UTF-8" + }, + { + "value": "pl", + "description": "Polish - Deprecated" + }, + { + "value": "pl.utf-8", + "description": "Polish with UTF-8" + }, + { + "value": "pt", + "description": "Portuguese - Deprecated" + }, + { + "value": "pt.utf-8", + "description": "Portuguese with UTF-8" + }, + { + "value": "c", + "description": "Posix - Deprecated" + }, + { + "value": "ro", + "description": "Romanian - Deprecated" + }, + { + "value": "ro.utf-8", + "description": "Romanian with UTF-8" + }, + { + "value": "ru", + "description": "Russian - Deprecated" + }, + { + "value": "ru.utf-8", + "description": "Russian with UTF-8" + }, + { + "value": "zh", + "description": "Simplified Chinese - Deprecated" + }, + { + "value": "zh.utf-8", + "description": "Simplified Chinese with UTF-8" + }, + { + "value": "zh.gbk", + "description": "Simplified gbk Chinese" + }, + { + "value": "zh.gbk.utf-8", + "description": "Simplified gbk Chinese with UTF-8 - Deprecated" + }, + { + "value": "zh-tw.big5", + "description": "Traditional Chinese BIG 5" + }, + { + "value": "zh-tw.big5.utf-8", + "description": "Traditional Chinese BIG 5 with UTF-8 - Deprecated" + }, + { + "value": "zh-tw", + "description": "Traditional Chinese EUC-TW" + }, + { + "value": "zh-tw.utf-8", + "description": "Traditional Chinese EUC-TW with UTF-8 - Deprecated" + }, + { + "value": "sk", + "description": "Slovak - Deprecated" + }, + { + "value": "sk.utf-8", + "description": "Slovak with UTF-8" + }, + { + "value": "sl", + "description": "Slovenian - Deprecated" + }, + { + "value": "sl.utf-8", + "description": "Slovenian with UTF-8" + }, + { + "value": "es", + "description": "Spanish - Deprecated" + }, + { + "value": "es.utf-8", + "description": "Spanish with UTF-8" + }, + { + "value": "sv", + "description": "Swedish - Deprecated" + }, + { + "value": "sv.utf-8", + "description": "Swedish with UTF-8" + }, + { + "value": "tr", + "description": "Turkish - Deprecated" + }, + { + "value": "tr.utf-8", + "description": "Turkish with UTF-8" + }, + { + "value": "en-us", + "description": "US English - Deprecated" + }, + { + "value": "en-us.utf-8", + "description": "US English with UTF-8" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "description": "Type of quota", + "$ref": "#/definitions/quotaType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running ", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota rule", + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "IndividualUserQuota" + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "encryptionTransitionRequest": { + "description": "Encryption transition request", + "type": "object", + "required": [ + "virtualNetworkId", + "privateEndpointId" + ], + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + }, + "description": "Identifier for the virtual network", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateEndpoints" + } + ] + }, + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "coolAccessTieringPolicy": { + "type": "string", + "description": "coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.", + "enum": [ + "Auto", + "SnapshotOnly" + ], + "x-ms-enum": { + "name": "coolAccessTieringPolicy", + "modelAsString": true + } + }, + "clusterPeerCommandResponse": { + "description": "Information about cluster peering process", + "type": "object", + "properties": { + "peerAcceptCommand": { + "description": "A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if clusterPeeringStatus is pending", + "type": "string" + } + } + }, + "svmPeerCommandResponse": { + "description": "Information about svm peering process", + "type": "object", + "properties": { + "svmPeeringCommand": { + "description": "A command that needs to be run on the external ONTAP to accept svm peering. Will only be present if svmPeeringStatus is pending", + "type": "string" + } + } + }, + "peerClusterForVolumeMigrationRequest": { + "description": "Source Cluster properties for a cluster peer request", + "type": "object", + "required": [ + "peerIpAddresses" + ], + "properties": { + "peerIpAddresses": { + "type": "array", + "minItems": 1, + "description": "A list of IC-LIF IPs that can be used to connect to the On-prem cluster", + "example": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ], + "items": { + "type": "string" + } + } + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + }, + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults" + } + ] + }, + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + }, + "isLargeVolume": { + "type": "boolean", + "readOnly": true, + "description": "Specifies if the backup is for a large volume.", + "example": false + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults" + } + ] + }, + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + }, + "changeKeyVault": { + "description": "Change key vault request", + "type": "object", + "required": [ + "keyVaultUri", + "keyName", + "keyVaultPrivateEndpoints" + ], + "properties": { + "keyVaultUri": { + "title": "keyVaultUri", + "description": "The URI of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "https://my-key-vault.managedhsm.azure.net" + }, + "keyName": { + "title": "keyName", + "description": "The name of the key that should be used for encryption.", + "type": "string", + "example": "rsaKeyName" + }, + "keyVaultResourceId": { + "title": "keyVaultResourceId", + "description": "Azure resource ID of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "keyVaultPrivateEndpoints": { + "title": "keyVaultPrivateEndpoints", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/keyVaultPrivateEndpoint" + }, + "x-ms-identifiers": [ + "virtualNetworkId" + ] + } + } + }, + "keyVaultPrivateEndpoint": { + "title": "keyVaultPrivateEndpoint", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "object", + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "description": "Identifier for the virtual network id", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + }, + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateEndpoints" + } + ] + }, + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index a4c7d252321e..cf04875a3983 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -38,6 +38,16 @@ These settings apply only when `--tag=package-2024-09-01` is specified on the co ```yaml $(tag) == 'package-2024-09-01' input-file: - Microsoft.NetApp/stable/2024-09-01/netapp.json +tag: package-preview-2024-09-01 +``` + +### Tag: package-preview-2024-09-01-preview + +These settings apply only when `--tag=package-preview-2024-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-09-01-preview' +input-file: + - Microsoft.NetApp/preview/2024-09-01-preview/netapp.json ``` ### Tag: package-preview-2024-07-01-preview From 5c3e40003cc3b1a9b613e39771960a03d4e4a292 Mon Sep 17 00:00:00 2001 From: Xinyi Joffre Date: Thu, 30 Jan 2025 10:00:29 -0800 Subject: [PATCH 73/74] [Quantum] ARM Typespec Migration for Azure Quantum (#32339) Initial typespec migration --- .../QuantumWorkspace.tsp | 95 ++ .../examples/2023-11-13-preview/listKeys.json | 27 + .../2023-11-13-preview/offeringsList.json | 92 ++ .../2023-11-13-preview/operations.json | 25 + ...uantumWorkspacesCheckNameAvailability.json | 22 + .../quantumWorkspacesDelete.json | 24 + .../quantumWorkspacesGet.json | 70 + .../quantumWorkspacesListResourceGroup.json | 57 + .../quantumWorkspacesListSubscription.json | 56 + .../quantumWorkspacesPatch.json | 76 + .../quantumWorkspacesPut.json | 139 ++ .../2023-11-13-preview/regenerateKey.json | 19 + .../Microsoft.Quantum.Management/main.tsp | 48 + .../Microsoft.Quantum.Management/models.tsp | 537 +++++++ .../Microsoft.Quantum.Management/routes.tsp | 37 + .../tspconfig.yaml | 15 + .../2023-11-13-preview/examples/listKeys.json | 2 + .../examples/offeringsList.json | 2 + .../examples/operations.json | 2 + ...uantumWorkspacesCheckNameAvailability.json | 6 +- .../examples/quantumWorkspacesDelete.json | 11 +- .../examples/quantumWorkspacesGet.json | 2 + .../quantumWorkspacesListResourceGroup.json | 2 + .../quantumWorkspacesListSubscription.json | 2 + .../examples/quantumWorkspacesPatch.json | 4 +- .../examples/quantumWorkspacesPut.json | 4 +- .../examples/regenerateKey.json | 4 +- .../preview/2023-11-13-preview/quantum.json | 1311 +++++++++-------- 28 files changed, 2071 insertions(+), 620 deletions(-) create mode 100644 specification/quantum/Microsoft.Quantum.Management/QuantumWorkspace.tsp create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/listKeys.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/offeringsList.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/operations.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesCheckNameAvailability.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesDelete.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesGet.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListResourceGroup.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListSubscription.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPatch.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPut.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/regenerateKey.json create mode 100644 specification/quantum/Microsoft.Quantum.Management/main.tsp create mode 100644 specification/quantum/Microsoft.Quantum.Management/models.tsp create mode 100644 specification/quantum/Microsoft.Quantum.Management/routes.tsp create mode 100644 specification/quantum/Microsoft.Quantum.Management/tspconfig.yaml diff --git a/specification/quantum/Microsoft.Quantum.Management/QuantumWorkspace.tsp b/specification/quantum/Microsoft.Quantum.Management/QuantumWorkspace.tsp new file mode 100644 index 000000000000..2138588a72ef --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/QuantumWorkspace.tsp @@ -0,0 +1,95 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Quantum; +/** + * The resource proxy definition object for Quantum Workspace. + */ +model QuantumWorkspace + is Azure.ResourceManager.TrackedResource { + ...ResourceNameParameter< + Resource = QuantumWorkspace, + KeyName = "workspaceName", + SegmentName = "workspaces", + NamePattern = "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" + >; + ...Azure.ResourceManager.ManagedServiceIdentityProperty; +} + +@armResourceOperations +interface Workspaces { + /** + * Check the availability of the resource name for the given location. + */ + checkNameAvailability is checkLocalNameAvailability; + + /** + * Returns the Workspace resource associated with the given name. + */ + get is ArmResourceRead; + + /** + * Creates or updates a Workspace resource. + */ + createOrUpdate is ArmResourceCreateOrReplaceAsync; + + /** + * Updates an existing Workspace's tags. + */ + @parameterVisibility + updateTags is ArmCustomPatchSync; + + /** + * Deletes a Workspace resource. + */ + delete is ArmResourceDeleteWithoutOkAsync; + + /** + * Gets the list of Workspaces within a resource group. + */ + listByResourceGroup is ArmResourceListByParent; + + /** + * Gets the list of Workspaces within a Subscription. + */ + listBySubscription is ArmListBySubscription; + + /** + * Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration. + */ + listKeys is ArmResourceActionSync< + QuantumWorkspace, + void, + ArmResponse + >; + + /** + * Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately. + */ + @action("regenerateKey") + regenerateKeys is ArmResourceActionSync< + QuantumWorkspace, + ApiKeys, + NoContentResponse + >; +} + +@@doc(QuantumWorkspace.name, "The name of the quantum workspace resource."); +@@doc(QuantumWorkspace.properties, + "Gets or sets the properties. Define quantum workspace's specific properties." +); +@@doc(Workspaces.createOrUpdate::parameters.resource, "Workspace details."); +@@doc(Workspaces.updateTags::parameters.properties, + "Parameters supplied to update tags." +); +@@doc(Workspaces.regenerateKeys::parameters.body, + "Which key to regenerate: primary or secondary." +); diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/listKeys.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/listKeys.json new file mode 100644 index 000000000000..8584a5d4fc1b --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/listKeys.json @@ -0,0 +1,27 @@ +{ + "operationId": "Workspaces_ListKeys", + "title": "Workspaces_ListKeys", + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "workspaceName": "quantumworkspace1" + }, + "responses": { + "200": { + "body": { + "apiKeyEnabled": true, + "primaryKey": { + "createdAt": "2023-11-13T23:06:09.147165Z", + "key": "" + }, + "secondaryKey": { + "createdAt": "2023-11-13T23:06:09.147165Z", + "key": "" + }, + "primaryConnectionString": "", + "secondaryConnectionString": "" + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/offeringsList.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/offeringsList.json new file mode 100644 index 000000000000..2c6192cb4b56 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/offeringsList.json @@ -0,0 +1,92 @@ +{ + "operationId": "Offerings_List", + "title": "Offerings_List", + "parameters": { + "subscriptionId": "1C4B2828-7D49-494F-933D-061373BE28C2", + "api-version": "2023-11-13-preview", + "locationName": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "QIO", + "name": "Quantum Inspired Optimization", + "properties": { + "description": "Provide Quantum Inspired Optimization solvers", + "targets": [ + { + "name": "CPU annealer", + "id": "p1", + "description": "CPU annealer algorithm" + } + ], + "skus": [ + { + "name": "Standard", + "id": "Standard", + "version": "1.0", + "description": "Provider CPU and FPGA QIO based solver.", + "restrictedAccessUri": "https://endpoint", + "autoAdd": true, + "targets": [ + "p1" + ], + "quotaDimensions": [ + { + "id": "quota1", + "scope": "Workspace" + } + ], + "pricingDetails": [ + { + "id": "price", + "value": "200 dollars" + }, + { + "id": "rate", + "value": "10 hours/month" + } + ] + } + ], + "quotaDimensions": [ + { + "id": "job-count", + "scope": "Workspace", + "period": "Monthly", + "quota": 30, + "name": "Job count", + "description": "The number of jobs you may submit per month", + "unit": "job", + "unitPlural": "jobs" + }, + { + "id": "job-hour", + "scope": "Subscription", + "period": "Monthly", + "quota": 1000, + "name": "Job hours", + "description": "The number of hours of solver time you may use per month", + "unit": "hour", + "unitPlural": "hours" + } + ], + "pricingDimensions": [ + { + "id": "price", + "name": "Pricing" + }, + { + "id": "rate", + "name": "Minimum monthly rate" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/operations.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/operations.json new file mode 100644 index 000000000000..5596457998cc --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/operations.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List", + "parameters": { + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Quantum/Locations/Offerings/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.Quantum", + "resource": "Workspaces", + "operation": "Read quantum workspace's available providers", + "description": "Read providers supported" + } + } + ] + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesCheckNameAvailability.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesCheckNameAvailability.json new file mode 100644 index 000000000000..e542ff81a0d9 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesCheckNameAvailability.json @@ -0,0 +1,22 @@ +{ + "operationId": "Workspaces_CheckNameAvailability", + "title": "Workspaces_CheckNameAvailability", + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "location": "westus2", + "body": { + "name": "sample-workspace-name", + "type": "Microsoft.Quantum/Workspaces" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource name already exists" + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesDelete.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesDelete.json new file mode 100644 index 000000000000..8b80e8614d24 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesDelete.json @@ -0,0 +1,24 @@ +{ + "operationId": "Workspaces_Delete", + "title": "Workspaces_Delete", + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" + }, + "description": "Workspace delete request accepted." + }, + "204": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" + }, + "description": "Workspace does not exist." + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesGet.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesGet.json new file mode 100644 index 000000000000..3d00f223e51e --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesGet.json @@ -0,0 +1,70 @@ +{ + "operationId": "Workspaces_Get", + "title": "Workspaces_Get", + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "IonQ", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-i1", + "instanceUri": "https://i1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "OneQBit", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-o1", + "instanceUri": "https://o1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListResourceGroup.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListResourceGroup.json new file mode 100644 index 000000000000..9f63fa0fe6e9 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListResourceGroup.json @@ -0,0 +1,57 @@ +{ + "operationId": "Workspaces_ListByResourceGroup", + "title": "Workspaces_ListByResourceGroup", + "parameters": { + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListSubscription.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListSubscription.json new file mode 100644 index 000000000000..8a0d1115cd25 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesListSubscription.json @@ -0,0 +1,56 @@ +{ + "operationId": "Workspaces_ListBySubscription", + "title": "Workspaces_ListBySubscription", + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPatch.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPatch.json new file mode 100644 index 000000000000..bd8f7bb1c149 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPatch.json @@ -0,0 +1,76 @@ +{ + "operationId": "Workspaces_UpdateTags", + "title": "Workspaces_UpdateTags", + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "IonQ", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-i1", + "instanceUri": "https://i1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444445" + }, + { + "providerId": "OneQBit", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-o1", + "instanceUri": "https://o1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444446" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPut.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPut.json new file mode 100644 index 000000000000..4dc78324efbd --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/quantumWorkspacesPut.json @@ -0,0 +1,139 @@ +{ + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspaces_CreateOrUpdate", + "parameters": { + "workspaceName": "quantumworkspace1", + "resourceGroupName": "quantumResourcegroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "resource": { + "location": "West US", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic" + }, + { + "providerId": "IonQ", + "providerSku": "Basic" + }, + { + "providerId": "OneQBit", + "providerSku": "Basic" + } + ], + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "type": "Microsoft.Quantum/Workspaces", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "instanceUri": "https://h1.endpoint.com", + "provisioningState": "Succeeded", + "resourceUsageId": "00000000-1111-2222-3333-444444444444" + }, + { + "providerId": "IonQ", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-i1", + "instanceUri": "https://i1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444445" + }, + { + "providerId": "OneQBit", + "provisioningState": "Succeeded", + "applicationName": "quantumworkspace1-o1", + "instanceUri": "https://o1.endpoint.com", + "providerSku": "Basic", + "resourceUsageId": "00000000-1111-2222-3333-444444444446" + } + ], + "provisioningState": "Succeeded", + "usable": "Yes", + "storageAccount": "/subscriptions/1C4B2828-7D49-494F-933D-061373BE28C2/resourceGroups/quantumResourcegroup/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "endpointUri": "https://quantumworkspace1.westus.quantum.azure.com", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/Workspaces/quantumworkspace1", + "name": "quantumworkspace1", + "properties": { + "providers": [ + { + "providerId": "Honeywell", + "providerSku": "Basic", + "applicationName": "quantumworkspace1-h1", + "provisioningState": "Launching" + }, + { + "providerId": "IonQ", + "provisioningState": "Launching", + "applicationName": "quantumworkspace1-i1", + "providerSku": "Basic" + }, + { + "providerId": "OneQBit", + "provisioningState": "Launching", + "applicationName": "quantumworkspace1-o1", + "providerSku": "Basic" + } + ], + "provisioningState": "ProviderLaunching", + "usable": "No", + "apiKeyEnabled": true + }, + "location": "West US", + "tags": { + "department": "MightyMight", + "company": "Contoso" + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/regenerateKey.json b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/regenerateKey.json new file mode 100644 index 000000000000..7aa3bd11ee44 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/examples/2023-11-13-preview/regenerateKey.json @@ -0,0 +1,19 @@ +{ + "operationId": "Workspaces_RegenerateKeys", + "title": "Workspaces_RegenerateKeys", + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2023-11-13-preview", + "resourceGroupName": "quantumResourcegroup", + "workspaceName": "quantumworkspace1", + "body": { + "keys": [ + "Primary", + "Secondary" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/quantum/Microsoft.Quantum.Management/main.tsp b/specification/quantum/Microsoft.Quantum.Management/main.tsp new file mode 100644 index 000000000000..0da04b217383 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/main.tsp @@ -0,0 +1,48 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: false + * guessResourceKey: false + * Version: 0.10.8 + * Date: 2025-01-24T21:00:59.273Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./QuantumWorkspace.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +/** + * Microsoft.Quantum Resource Provider Management API + */ +@armProviderNamespace +@service({ + title: "Azure Quantum Management API", +}) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.Quantum; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2023-11-13-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2023_11_13_preview: "2023-11-13-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/quantum/Microsoft.Quantum.Management/models.tsp b/specification/quantum/Microsoft.Quantum.Management/models.tsp new file mode 100644 index 000000000000..f1ac79b39cde --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/models.tsp @@ -0,0 +1,537 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +namespace Microsoft.Quantum; + +/** + * Provisioning status field + */ +union ProviderStatus { + string, + + /** The provider is successfully provisioned. */ + Succeeded: "Succeeded", + + /** The provider is starting provisioning. */ + Launching: "Launching", + + /** The provider is updating. */ + Updating: "Updating", + + /** The provider is deleting. */ + Deleting: "Deleting", + + /** The provider is deleted. */ + Deleted: "Deleted", + + /** The provider is failed. */ + Failed: "Failed", +} + +/** + * Whether the current workspace is ready to accept Jobs. + */ +union UsableStatus { + string, + + /** The workspace is usable and can accept jobs. */ + Yes: "Yes", + + /** The workspace is not usable and cannot accept jobs. */ + No: "No", + + /** The workspace is partially usable. */ + Partial: "Partial", +} + +/** + * The Workspace provisioning status. + */ +union WorkspaceProvisioningStatus { + ResourceProvisioningState, + + /** The Workspace provisioning is succeeded. */ + Succeeded: "Succeeded", + + /** The Workspace is currently starting to provision a provider. */ + ProviderLaunching: "ProviderLaunching", + + /** The Workspace is currently updating a provider. */ + ProviderUpdating: "ProviderUpdating", + + /** The Workspace is currently deleting a provider. */ + ProviderDeleting: "ProviderDeleting", + + /** The Workspace is currently provisioning a provider. */ + ProviderProvisioning: "ProviderProvisioning", + + /** The Workspace provisioning failed. */ + Failed: "Failed", +} + +/** + * The API key type. + */ +union KeyType { + string, + + /** The primary API key. */ + Primary: "Primary", + + /** The secondary API key. */ + Secondary: "Secondary", +} + +/** + * The response of a list Providers operation. + */ +model OfferingsListResult is Azure.Core.Page; + +/** + * Information about an offering. A provider offering is an entity that offers Targets to run Azure Quantum Jobs. + */ +model ProviderDescription { + /** + * Unique provider's id. + */ + id?: string; + + /** + * Provider's display name. + */ + @visibility("read") + name?: string; + + /** + * Provider properties. + */ + properties?: ProviderProperties; +} + +/** + * Provider properties. + */ +model ProviderProperties { + /** + * A description about this provider. + */ + @visibility("read") + description?: string; + + /** + * Provider type. + */ + @visibility("read") + providerType?: string; + + /** + * Company name. + */ + @visibility("read") + company?: string; + + /** + * Provider's default endpoint. + */ + @visibility("read") + defaultEndpoint?: string; + + /** + * Azure Active Directory info. + */ + aad?: ProviderPropertiesAad; + + /** + * Provider's Managed-Application info + */ + managedApplication?: ProviderPropertiesManagedApplication; + + /** + * The list of targets available from this provider. + */ + targets?: TargetDescription[]; + + /** + * The list of skus available from this provider. + */ + skus?: SkuDescription[]; + + /** + * The list of quota dimensions from the provider. + */ + quotaDimensions?: QuotaDimension[]; + + /** + * The list of pricing dimensions from the provider. + */ + pricingDimensions?: PricingDimension[]; +} + +/** + * Azure Active Directory info. + */ +model ProviderPropertiesAad { + /** + * Provider's application id. + */ + @visibility("read") + applicationId?: string; + + /** + * Provider's tenant id. + */ + @visibility("read") + tenantId?: string; +} + +/** + * Provider's Managed-Application info + */ +model ProviderPropertiesManagedApplication { + /** + * Provider's publisher id. + */ + @visibility("read") + publisherId?: string; + + /** + * Provider's offer id. + */ + @visibility("read") + offerId?: string; +} + +/** + * Information about a Target. A target is the component that can process a specific type of Job. + */ +model TargetDescription { + /** + * Unique target id. + */ + id?: string; + + /** + * Display name of this target. + */ + name?: string; + + /** + * A description about this target. + */ + description?: string; + + /** + * List of data formats accepted by this target. + */ + acceptedDataFormats?: string[]; + + /** + * List of content encodings accepted by this target. + */ + acceptedContentEncodings?: string[]; +} + +/** + * Information about a specific sku. + */ +model SkuDescription { + /** + * Unique sku id. + */ + id?: string; + + /** + * Display name of this sku. + */ + name?: string; + + /** + * Display name of this sku. + */ + version?: string; + + /** + * Description about this sku. + */ + description?: string; + + /** + * Uri to subscribe to the restricted access sku. + */ + restrictedAccessUri?: string; + + /** + * Flag to indicate whether the sku should be automatically added during workspace creation. + */ + autoAdd?: boolean; + + /** + * The list of targets available for this sku. + */ + targets?: string[]; + + /** + * The list of quota dimensions for this sku. + */ + quotaDimensions?: QuotaDimension[]; + + /** + * The list of pricing details for the sku. + */ + pricingDetails?: PricingDetail[]; +} + +/** + * Information about a specific quota dimension. + */ +model QuotaDimension { + /** + * Unique id of this dimension. + */ + id?: string; + + /** + * The scope of this quota dimension. + */ + scope?: string; + + /** + * The reset period of this quota dimension. + */ + period?: string; + + /** + * The max limit of this dimension. + */ + quota?: float32; + + /** + * The display name of this quota dimension. + */ + name?: string; + + /** + * A description about this quota dimension. + */ + description?: string; + + /** + * The standard unit of measurement used for this quota dimension. + */ + unit?: string; + + /** + * The standard unit of measurement used for this quota dimension in plural form. + */ + unitPlural?: string; +} + +/** + * Detailed pricing information for an sku. + */ +model PricingDetail { + /** + * Unique id for this pricing information. + */ + id?: string; + + /** + * The unit cost of this sku. + */ + value?: string; +} + +/** + * Information about pricing dimension. + */ +model PricingDimension { + /** + * Unique id of this pricing dimension. + */ + id?: string; + + /** + * The display name of this pricing dimension. + */ + name?: string; +} + +/** + * Properties of a Workspace + */ +model WorkspaceResourceProperties { + /** + * List of Providers selected for this Workspace + */ + @OpenAPI.extension("x-ms-identifiers", ["providerId"]) + providers?: Provider[]; + + /** + * Whether the current workspace is ready to accept Jobs. + */ + @visibility("read") + usable?: UsableStatus; + + /** + * Provisioning status field + */ + @visibility("read") + provisioningState?: WorkspaceProvisioningStatus; + + /** + * ARM Resource Id of the storage account associated with this workspace. + */ + storageAccount?: string; + + /** + * The URI of the workspace endpoint. + */ + @visibility("read") + endpointUri?: string; + + /** + * Indicator of enablement of the Quantum workspace Api keys. + */ + apiKeyEnabled?: boolean; +} + +/** + * Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs. + */ +model Provider { + /** + * Unique id of this provider. + */ + providerId?: string; + + /** + * The sku associated with pricing information for this provider. + */ + providerSku?: string; + + /** + * A Uri identifying the specific instance of this provider. + */ + instanceUri?: string; + + /** + * The provider's marketplace application display name. + */ + applicationName?: string; + + /** + * Provisioning status field + */ + provisioningState?: ProviderStatus; + + /** + * Id to track resource usage for the provider. + */ + resourceUsageId?: string; +} + +/** + * Common fields that are returned in the response for all Azure Resource Manager resources + */ +model Resource { + /** + * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + */ + @visibility("read") + id?: Azure.Core.armResourceIdentifier; + + /** + * The name of the resource + */ + @visibility("read") + name?: string; + + /** + * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" + */ + @visibility("read") + type?: string; + + /** + * Azure Resource Manager metadata containing createdBy and modifiedBy information. + */ + @visibility("read") + systemData?: SystemData; +} + +/** + * Tags object for patch operations. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/patch-envelope" "" +model TagsObject { + /** + * Resource tags. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "" + tags?: Record; +} + +/** + * Result of list Api keys and connection strings. + */ +model ListKeysResult { + /** + * Indicator of enablement of the Quantum workspace Api keys. + */ + apiKeyEnabled?: boolean; + + /** + * The quantum workspace primary api key. + */ + primaryKey?: ApiKey; + + /** + * The quantum workspace secondary api key. + */ + secondaryKey?: ApiKey; + + /** + * The connection string of the primary api key. + */ + @visibility("read") + primaryConnectionString?: string; + + /** + * The connection string of the secondary api key. + */ + @visibility("read") + secondaryConnectionString?: string; +} + +/** + * Azure quantum workspace Api key details. + */ +model ApiKey { + /** + * The creation time of the api key. + */ + createdAt?: utcDateTime; + + /** + * The Api key. + */ + @visibility("read") + key?: string; +} + +/** + * List of api keys to be generated. + */ +model ApiKeys { + /** + * A list of api key names. + */ + keys?: KeyType[]; +} diff --git a/specification/quantum/Microsoft.Quantum.Management/routes.tsp b/specification/quantum/Microsoft.Quantum.Management/routes.tsp new file mode 100644 index 000000000000..440e0a960167 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/routes.tsp @@ -0,0 +1,37 @@ +// FIXME: Operations in this file are not detected as a resource operation, please confirm the conversion result manually + +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.OpenAPI; + +namespace Microsoft.Quantum; + +@armResourceOperations +interface Offerings { + /** + * Returns the list of all provider offerings available for the given location. + */ + @autoRoute + @get + @action("offerings") + list is ArmProviderActionSync< + Response = OfferingsListResult, + Scope = SubscriptionActionScope, + Parameters = { + /** + * Location. + */ + @path + @segment("locations") + locationName: string; + } + >; +} diff --git a/specification/quantum/Microsoft.Quantum.Management/tspconfig.yaml b/specification/quantum/Microsoft.Quantum.Management/tspconfig.yaml new file mode 100644 index 000000000000..a1b389ced369 --- /dev/null +++ b/specification/quantum/Microsoft.Quantum.Management/tspconfig.yaml @@ -0,0 +1,15 @@ +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: + "{azure-resource-provider-folder}/{service-name}/{version-status}/\ + {version}/quantum.json" + examples-dir: "{project-root}/examples" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json index 7586f4c36e1a..8584a5d4fc1b 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/listKeys.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_ListKeys", + "title": "Workspaces_ListKeys", "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "api-version": "2023-11-13-preview", diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json index 8635af13c6db..2c6192cb4b56 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/offeringsList.json @@ -1,4 +1,6 @@ { + "operationId": "Offerings_List", + "title": "Offerings_List", "parameters": { "subscriptionId": "1C4B2828-7D49-494F-933D-061373BE28C2", "api-version": "2023-11-13-preview", diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json index e3ea4c38b772..5596457998cc 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/operations.json @@ -1,4 +1,6 @@ { + "operationId": "Operations_List", + "title": "Operations_List", "parameters": { "api-version": "2023-11-13-preview" }, diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json index 0dbf8b42c4f6..e542ff81a0d9 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesCheckNameAvailability.json @@ -1,9 +1,11 @@ { + "operationId": "Workspaces_CheckNameAvailability", + "title": "Workspaces_CheckNameAvailability", "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "api-version": "2023-11-13-preview", - "locationName": "westus2", - "checkNameAvailabilityParameters": { + "location": "westus2", + "body": { "name": "sample-workspace-name", "type": "Microsoft.Quantum/Workspaces" } diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json index af939aedf2d6..8b80e8614d24 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesDelete.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_Delete", + "title": "Workspaces_Delete", "parameters": { "workspaceName": "quantumworkspace1", "resourceGroupName": "quantumResourcegroup", @@ -6,12 +8,6 @@ "api-version": "2023-11-13-preview" }, "responses": { - "200": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" - }, - "description": "Successful." - }, "202": { "headers": { "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" @@ -21,7 +17,8 @@ "204": { "headers": { "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-13-preview" - } + }, + "description": "Workspace does not exist." } } } diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json index 08f30f8b32a7..3d00f223e51e 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesGet.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_Get", + "title": "Workspaces_Get", "parameters": { "workspaceName": "quantumworkspace1", "resourceGroupName": "quantumResourcegroup", diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json index c07998dc31c8..9f63fa0fe6e9 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListResourceGroup.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_ListByResourceGroup", + "title": "Workspaces_ListByResourceGroup", "parameters": { "resourceGroupName": "quantumResourcegroup", "subscriptionId": "00000000-1111-2222-3333-444444444444", diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json index 56eeeb42b186..8a0d1115cd25 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesListSubscription.json @@ -1,4 +1,6 @@ { + "operationId": "Workspaces_ListBySubscription", + "title": "Workspaces_ListBySubscription", "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "api-version": "2023-11-13-preview" diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json index a096f8332a83..bd8f7bb1c149 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPatch.json @@ -1,10 +1,12 @@ { + "operationId": "Workspaces_UpdateTags", + "title": "Workspaces_UpdateTags", "parameters": { "workspaceName": "quantumworkspace1", "resourceGroupName": "quantumResourcegroup", "subscriptionId": "00000000-1111-2222-3333-444444444444", "api-version": "2023-11-13-preview", - "workspaceTags": { + "properties": { "tags": { "tag1": "value1", "tag2": "value2" diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json index 9c02fb1b3253..4dc78324efbd 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/quantumWorkspacesPut.json @@ -1,10 +1,12 @@ { + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspaces_CreateOrUpdate", "parameters": { "workspaceName": "quantumworkspace1", "resourceGroupName": "quantumResourcegroup", "subscriptionId": "00000000-1111-2222-3333-444444444444", "api-version": "2023-11-13-preview", - "QuantumWorkspace": { + "resource": { "location": "West US", "properties": { "providers": [ diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json index bad23f8cbf92..7aa3bd11ee44 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/examples/regenerateKey.json @@ -1,10 +1,12 @@ { + "operationId": "Workspaces_RegenerateKeys", + "title": "Workspaces_RegenerateKeys", "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "api-version": "2023-11-13-preview", "resourceGroupName": "quantumResourcegroup", "workspaceName": "quantumworkspace1", - "keySpecification": { + "body": { "keys": [ "Primary", "Secondary" diff --git a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json index f4a5f5f1c99a..b9ab23042fd7 100644 --- a/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json +++ b/specification/quantum/resource-manager/Microsoft.Quantum/preview/2023-11-13-preview/quantum.json @@ -1,20 +1,23 @@ { "swagger": "2.0", "info": { - "title": "Azure Quantum Management Client", + "title": "Azure Quantum Management API", "version": "2023-11-13-preview", - "x-ms-code-generation-settings": { - "name": "QuantumManagementClient" - } + "description": "Microsoft.Quantum Resource Provider Management API", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] }, - "host": "management.azure.com", "schemes": [ "https" ], - "consumes": [ + "host": "management.azure.com", + "produces": [ "application/json" ], - "produces": [ + "consumes": [ "application/json" ], "security": [ @@ -27,65 +30,70 @@ "securityDefinitions": { "azure_auth": { "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Workspaces" + }, + { + "name": "Offerings" + } + ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}": { + "/providers/Microsoft.Quantum/operations": { "get": { - "description": "Returns the Workspace resource associated with the given name.", - "operationId": "Workspaces_Get", - "x-ms-examples": { - "QuantumWorkspacesGet": { - "$ref": "./examples/quantumWorkspacesGet.json" - } - }, + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" } ], "responses": { "200": { - "description": "Workspace details.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/QuantumWorkspace" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "put": { - "description": "Creates or updates a workspace resource.", - "operationId": "Workspaces_CreateOrUpdate", + }, "x-ms-examples": { - "QuantumWorkspacesPut": { - "$ref": "./examples/quantumWorkspacesPut.json" + "Operations_List": { + "$ref": "./examples/operations.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{location}/checkNameAvailability": { + "post": { + "operationId": "Workspaces_CheckNameAvailability", + "tags": [ + "Workspaces" + ], + "description": "Check the availability of the resource name for the given location.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, @@ -93,55 +101,47 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { - "name": "QuantumWorkspace", - "description": "Workspace details.", + "name": "body", "in": "body", + "description": "The CheckAvailability request", "required": true, "schema": { - "$ref": "#/definitions/QuantumWorkspace" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" } } ], "responses": { - "201": { - "description": "Workspace create/update request accepted.", - "schema": { - "$ref": "#/definitions/QuantumWorkspace" - } - }, "200": { - "description": "Successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/QuantumWorkspace" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing workspace's tags.", - "operationId": "Workspaces_UpdateTags", "x-ms-examples": { - "QuantumWorkspacesPatchTags": { - "$ref": "./examples/quantumWorkspacesPatch.json" + "Workspaces_CheckNameAvailability": { + "$ref": "./examples/quantumWorkspacesCheckNameAvailability.json" } - }, + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings": { + "get": { + "operationId": "Offerings_List", + "tags": [ + "Offerings" + ], + "description": "Returns the list of all provider offerings available for the given location.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, @@ -149,86 +149,43 @@ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "workspaceTags", - "in": "body", + "name": "locationName", + "in": "path", + "description": "Location.", "required": true, - "schema": { - "$ref": "#/definitions/TagsObject" - }, - "description": "Parameters supplied to update tags." + "type": "string" } ], "responses": { "200": { - "description": "Successful.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/QuantumWorkspace" + "$ref": "#/definitions/OfferingsListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } - } - }, - "delete": { - "description": "Deletes a Workspace resource.", - "operationId": "Workspaces_Delete", - "x-ms-examples": { - "QuantumWorkspacesDelete": { - "$ref": "./examples/quantumWorkspacesDelete.json" - } }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Workspace delete request accepted." - }, - "204": { - "description": "No content - The workspace doesn't exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } + "x-ms-examples": { + "Offerings_List": { + "$ref": "./examples/offeringsList.json" } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces": { "get": { "operationId": "Workspaces_ListBySubscription", - "x-ms-examples": { - "QuantumWorkspacesListBySubscription": { - "$ref": "./examples/quantumWorkspacesListSubscription.json" - } - }, + "tags": [ + "Workspaces" + ], "description": "Gets the list of Workspaces within a Subscription.", "parameters": [ { @@ -240,18 +197,23 @@ ], "responses": { "200": { - "description": "Workspaces successfully returned.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkspaceListResult" + "$ref": "#/definitions/QuantumWorkspaceListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "Workspaces_ListBySubscription": { + "$ref": "./examples/quantumWorkspacesListSubscription.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -260,332 +222,386 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces": { "get": { "operationId": "Workspaces_ListByResourceGroup", - "x-ms-examples": { - "QuantumWorkspacesListByResourceGroup": { - "$ref": "./examples/quantumWorkspacesListResourceGroup.json" - } - }, + "tags": [ + "Workspaces" + ], "description": "Gets the list of Workspaces within a resource group.", "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "Workspaces successfully returned.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/WorkspaceListResult" + "$ref": "#/definitions/QuantumWorkspaceListResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, + "x-ms-examples": { + "Workspaces_ListByResourceGroup": { + "$ref": "./examples/quantumWorkspacesListResourceGroup.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}": { "get": { - "description": "Returns the list of all provider offerings available for the given location.", - "operationId": "Offerings_List", - "x-ms-examples": { - "OfferingsList": { - "$ref": "./examples/offeringsList.json" - } - }, + "operationId": "Workspaces_Get", + "tags": [ + "Workspaces" + ], + "description": "Returns the Workspace resource associated with the given name.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/LocationParameter" + "name": "workspaceName", + "in": "path", + "description": "The name of the quantum workspace resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" } ], "responses": { "200": { - "description": "Offerings details.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/OfferingsListResult" + "$ref": "#/definitions/QuantumWorkspace" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Quantum/operations": { - "get": { - "description": "Returns list of operations.", - "operationId": "Operations_List", "x-ms-examples": { - "Operations": { - "$ref": "./examples/operations.json" + "Workspaces_Get": { + "$ref": "./examples/quantumWorkspacesGet.json" } - }, + } + }, + "put": { + "operationId": "Workspaces_CreateOrUpdate", + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a Workspace resource.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the quantum workspace resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" + }, + { + "name": "resource", + "in": "body", + "description": "Workspace details.", + "required": true, + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } } ], "responses": { "200": { - "description": "Operation details.", + "description": "Resource 'QuantumWorkspace' update operation succeeded", + "schema": { + "$ref": "#/definitions/QuantumWorkspace" + } + }, + "201": { + "description": "Resource 'QuantumWorkspace' create operation succeeded", "schema": { - "$ref": "#/definitions/operationsList" + "$ref": "#/definitions/QuantumWorkspace" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability": { - "post": { - "description": "Check the availability of the resource name.", - "operationId": "Workspace_CheckNameAvailability", "x-ms-examples": { - "QuantumWorkspacesCheckNameAvailability": { - "$ref": "./examples/quantumWorkspacesCheckNameAvailability.json" + "Workspaces_CreateOrUpdate": { + "$ref": "./examples/quantumWorkspacesPut.json" } }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Workspaces_UpdateTags", + "tags": [ + "Workspaces" + ], + "description": "Updates an existing Workspace's tags.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/LocationParameter" + "name": "workspaceName", + "in": "path", + "description": "The name of the quantum workspace resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" }, { - "name": "checkNameAvailabilityParameters", + "name": "properties", "in": "body", + "description": "Parameters supplied to update tags.", "required": true, "schema": { - "$ref": "#/definitions/CheckNameAvailabilityParameters" - }, - "description": "The name and type of the resource." + "$ref": "#/definitions/TagsObject" + } } ], "responses": { "200": { - "description": "OK. The request has succeeded.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" + "$ref": "#/definitions/QuantumWorkspace" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys": { - "post": { - "description": "Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", - "operationId": "Workspace_ListKeys", "x-ms-examples": { - "ListKeys": { - "$ref": "./examples/listKeys.json" + "Workspaces_UpdateTags": { + "$ref": "./examples/quantumWorkspacesPatch.json" } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { + } + }, + "delete": { + "operationId": "Workspaces_Delete", + "tags": [ + "Workspaces" + ], + "description": "Deletes a Workspace resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the quantum workspace resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_Delete": { + "$ref": "./examples/quantumWorkspacesDelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys": { + "post": { + "operationId": "Workspaces_ListKeys", + "tags": [ + "Workspaces" + ], + "description": "Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.", + "parameters": [ + { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "name": "workspaceName", + "in": "path", + "description": "The name of the quantum workspace resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" } ], "responses": { "200": { - "description": "The request was successful.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListKeysResult" } }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Workspaces_ListKeys": { + "$ref": "./examples/listKeys.json" + } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/regenerateKey": { "post": { + "operationId": "Workspaces_RegenerateKeys", + "tags": [ + "Workspaces" + ], "description": "Regenerate either the primary or secondary key for use with the Quantum APIs. The old key will stop working immediately.", - "operationId": "Workspace_RegenerateKeys", - "x-ms-examples": { - "RegenerateKey": { - "$ref": "./examples/regenerateKey.json" - } - }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/WorkspaceNameParameter" + "name": "workspaceName", + "in": "path", + "description": "The name of the quantum workspace resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$" }, { - "name": "keySpecification", + "name": "body", "in": "body", - "required": true, "description": "Which key to regenerate: primary or secondary.", + "required": true, "schema": { - "$ref": "#/definitions/APIKeys" + "$ref": "#/definitions/ApiKeys" } } ], "responses": { "204": { - "description": "The request was successful." + "description": "There is no content to send for this request, but the headers may be useful." }, "default": { - "description": "Error response describing why the operation failed.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Workspaces_RegenerateKeys": { + "$ref": "./examples/regenerateKey.json" + } } } } }, "definitions": { - "WorkspaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/QuantumWorkspace" - }, - "description": "Result of a list Workspaces operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Workspaces." - } - }, - "description": "The response of a list Workspaces operation." - }, - "OfferingsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderDescription" - }, - "description": "Result of a list Providers operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Providers." - } - }, - "description": "The response of a list Providers operation." - }, - "QuantumWorkspace": { - "type": "object", - "description": "The resource proxy definition object for quantum workspace.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define quantum workspace's specific properties.", - "$ref": "#/definitions/WorkspaceResourceProperties" - }, - "identity": { - "type": "object", - "description": "Managed Identity information.", - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal ID of resource identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant ID of resource." - }, - "type": { - "type": "string", - "description": "The identity type.", - "enum": [ - "SystemAssigned", - "None" - ], - "x-ms-enum": { - "name": "ResourceIdentityType", - "modelAsString": true - } - } - } - }, - "systemData": { - "description": "System metadata", - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, "ApiKey": { - "description": "Azure quantum workspace Api key details.", "type": "object", + "description": "Azure quantum workspace Api key details.", "properties": { "createdAt": { "type": "string", @@ -593,16 +609,52 @@ "description": "The creation time of the api key." }, "key": { - "x-ms-secret": true, - "readOnly": true, "type": "string", - "description": "The Api key." + "description": "The Api key.", + "readOnly": true + } + } + }, + "ApiKeys": { + "type": "object", + "description": "List of api keys to be generated.", + "properties": { + "keys": { + "type": "array", + "description": "A list of api key names.", + "items": { + "$ref": "#/definitions/KeyType" + } } } }, + "KeyType": { + "type": "string", + "description": "The API key type.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "The primary API key." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "The secondary API key." + } + ] + } + }, "ListKeysResult": { - "description": "Result of list Api keys and connection strings.", "type": "object", + "description": "Result of list Api keys and connection strings.", "properties": { "apiKeyEnabled": { "type": "boolean", @@ -617,107 +669,93 @@ "description": "The quantum workspace secondary api key." }, "primaryConnectionString": { - "x-ms-secret": true, - "readOnly": true, "type": "string", - "description": "The connection string of the primary api key." + "description": "The connection string of the primary api key.", + "readOnly": true }, "secondaryConnectionString": { - "x-ms-secret": true, - "readOnly": true, "type": "string", - "description": "The connection string of the secondary api key." + "description": "The connection string of the secondary api key.", + "readOnly": true } } }, - "APIKeys": { + "OfferingsListResult": { "type": "object", + "description": "The response of a list Providers operation.", "properties": { - "keys": { - "description": "A list of api key names.", + "value": { "type": "array", + "description": "The ProviderDescription items on this page", "items": { - "type": "string", - "enum": [ - "Primary", - "Secondary" - ], - "default": "Primary", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": true - } + "$ref": "#/definitions/ProviderDescription" } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" } }, - "description": "List of api keys to be generated." + "required": [ + "value" + ] }, - "TagsObject": { + "PricingDetail": { + "type": "object", + "description": "Detailed pricing information for an sku.", "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." + "id": { + "type": "string", + "description": "Unique id for this pricing information." + }, + "value": { + "type": "string", + "description": "The unit cost of this sku." } - }, - "description": "Tags object for patch operations." + } }, - "WorkspaceResourceProperties": { - "description": "Properties of a Workspace", + "PricingDimension": { + "type": "object", + "description": "Information about pricing dimension.", "properties": { - "providers": { - "type": "array", - "description": "List of Providers selected for this Workspace", - "items": { - "$ref": "#/definitions/Provider" - }, - "x-ms-identifiers": [] + "id": { + "type": "string", + "description": "Unique id of this pricing dimension." }, - "usable": { + "name": { "type": "string", - "enum": [ - "Yes", - "No", - "Partial" - ], - "x-ms-enum": { - "name": "UsableStatus", - "modelAsString": true - }, - "description": "Whether the current workspace is ready to accept Jobs.", - "readOnly": true + "description": "The display name of this pricing dimension." + } + } + }, + "Provider": { + "type": "object", + "description": "Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.", + "properties": { + "providerId": { + "type": "string", + "description": "Unique id of this provider." }, - "provisioningState": { + "providerSku": { "type": "string", - "enum": [ - "Succeeded", - "ProviderLaunching", - "ProviderUpdating", - "ProviderDeleting", - "ProviderProvisioning", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "description": "Provisioning status field", - "readOnly": true + "description": "The sku associated with pricing information for this provider." }, - "storageAccount": { + "instanceUri": { "type": "string", - "description": "ARM Resource Id of the storage account associated with this workspace." + "description": "A Uri identifying the specific instance of this provider." }, - "endpointUri": { + "applicationName": { "type": "string", - "description": "The URI of the workspace endpoint.", - "readOnly": true + "description": "The provider's marketplace application display name." }, - "apiKeyEnabled": { - "type": "boolean", - "description": "Indicator of enablement of the Quantum workspace Api keys." + "provisioningState": { + "$ref": "#/definitions/ProviderStatus", + "description": "Provisioning status field" + }, + "resourceUsageId": { + "type": "string", + "description": "Id to track resource usage for the provider." } } }, @@ -735,7 +773,8 @@ "readOnly": true }, "properties": { - "$ref": "#/definitions/ProviderProperties" + "$ref": "#/definitions/ProviderProperties", + "description": "Provider properties." } } }, @@ -764,36 +803,12 @@ "readOnly": true }, "aad": { - "type": "object", - "description": "Azure Active Directory info.", - "properties": { - "applicationId": { - "type": "string", - "description": "Provider's application id.", - "readOnly": true - }, - "tenantId": { - "type": "string", - "description": "Provider's tenant id.", - "readOnly": true - } - } + "$ref": "#/definitions/ProviderPropertiesAad", + "description": "Azure Active Directory info." }, "managedApplication": { - "type": "object", - "description": "Provider's Managed-Application info", - "properties": { - "publisherId": { - "type": "string", - "description": "Provider's publisher id.", - "readOnly": true - }, - "offerId": { - "type": "string", - "description": "Provider's offer id.", - "readOnly": true - } - } + "$ref": "#/definitions/ProviderPropertiesManagedApplication", + "description": "Provider's Managed-Application info" }, "targets": { "type": "array", @@ -825,35 +840,163 @@ } } }, - "TargetDescription": { + "ProviderPropertiesAad": { "type": "object", - "description": "Information about a Target. A target is the component that can process a specific type of Job.", + "description": "Azure Active Directory info.", "properties": { - "id": { + "applicationId": { "type": "string", - "description": "Unique target id." + "description": "Provider's application id.", + "readOnly": true }, - "name": { + "tenantId": { "type": "string", - "description": "Display name of this target." - }, - "description": { + "description": "Provider's tenant id.", + "readOnly": true + } + } + }, + "ProviderPropertiesManagedApplication": { + "type": "object", + "description": "Provider's Managed-Application info", + "properties": { + "publisherId": { "type": "string", - "description": "A description about this target." + "description": "Provider's publisher id.", + "readOnly": true }, - "acceptedDataFormats": { - "type": "array", - "description": "List of data formats accepted by this target.", - "items": { - "type": "string" + "offerId": { + "type": "string", + "description": "Provider's offer id.", + "readOnly": true + } + } + }, + "ProviderStatus": { + "type": "string", + "description": "Provisioning status field", + "enum": [ + "Succeeded", + "Launching", + "Updating", + "Deleting", + "Deleted", + "Failed" + ], + "x-ms-enum": { + "name": "ProviderStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The provider is successfully provisioned." + }, + { + "name": "Launching", + "value": "Launching", + "description": "The provider is starting provisioning." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The provider is updating." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The provider is deleting." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "The provider is deleted." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The provider is failed." } + ] + }, + "readOnly": true + }, + "QuantumWorkspace": { + "type": "object", + "description": "The resource proxy definition object for Quantum Workspace.", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceResourceProperties", + "description": "Gets or sets the properties. Define quantum workspace's specific properties." }, - "acceptedContentEncodings": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "QuantumWorkspaceListResult": { + "type": "object", + "description": "The response of a QuantumWorkspace list operation.", + "properties": { + "value": { "type": "array", - "description": "List of content encodings accepted by this target.", + "description": "The QuantumWorkspace items on this page", "items": { - "type": "string" + "$ref": "#/definitions/QuantumWorkspace" } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "QuotaDimension": { + "type": "object", + "description": "Information about a specific quota dimension.", + "properties": { + "id": { + "type": "string", + "description": "Unique id of this dimension." + }, + "scope": { + "type": "string", + "description": "The scope of this quota dimension." + }, + "period": { + "type": "string", + "description": "The reset period of this quota dimension." + }, + "quota": { + "type": "number", + "format": "float", + "description": "The max limit of this dimension." + }, + "name": { + "type": "string", + "description": "The display name of this quota dimension." + }, + "description": { + "type": "string", + "description": "A description about this quota dimension." + }, + "unit": { + "type": "string", + "description": "The standard unit of measurement used for this quota dimension." + }, + "unitPlural": { + "type": "string", + "description": "The standard unit of measurement used for this quota dimension in plural form." } } }, @@ -908,223 +1051,175 @@ } } }, - "QuotaDimension": { - "type": "object", - "description": "Information about a specific quota dimension.", - "properties": { - "id": { - "type": "string", - "description": "Unique id of this dimension." - }, - "scope": { - "type": "string", - "description": "The scope of this quota dimension." - }, - "period": { - "type": "string", - "description": "The reset period of this quota dimension." - }, - "quota": { - "type": "number", - "description": "The max limit of this dimension." - }, - "name": { - "type": "string", - "description": "The display name of this quota dimension." - }, - "description": { - "type": "string", - "description": "A description about this quota dimension." - }, - "unit": { - "type": "string", - "description": "The standard unit of measurement used for this quota dimension." - }, - "unitPlural": { - "type": "string", - "description": "The standard unit of measurement used for this quota dimension in plural form." - } - } - }, - "PricingDetail": { + "TagsObject": { "type": "object", - "description": "Detailed pricing information for an sku.", + "description": "Tags object for patch operations.", "properties": { - "id": { - "type": "string", - "description": "Unique id for this pricing information." - }, - "value": { - "type": "string", - "description": "The unit cost of this sku." + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } } } }, - "PricingDimension": { + "TargetDescription": { "type": "object", - "description": "Information about pricing dimension.", + "description": "Information about a Target. A target is the component that can process a specific type of Job.", "properties": { "id": { "type": "string", - "description": "Unique id of this pricing dimension." + "description": "Unique target id." }, "name": { "type": "string", - "description": "The display name of this pricing dimension." - } - } - }, - "Provider": { - "type": "object", - "description": "Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs.", - "properties": { - "providerId": { - "type": "string", - "description": "Unique id of this provider." - }, - "providerSku": { - "type": "string", - "description": "The sku associated with pricing information for this provider." - }, - "instanceUri": { - "type": "string", - "description": "A Uri identifying the specific instance of this provider." + "description": "Display name of this target." }, - "applicationName": { + "description": { "type": "string", - "description": "The provider's marketplace application display name." + "description": "A description about this target." }, - "provisioningState": { - "type": "string", - "enum": [ - "Succeeded", - "Launching", - "Updating", - "Deleting", - "Deleted", - "Failed" - ], - "x-ms-enum": { - "name": "Status", - "modelAsString": true - }, - "description": "Provisioning status field" + "acceptedDataFormats": { + "type": "array", + "description": "List of data formats accepted by this target.", + "items": { + "type": "string" + } }, - "resourceUsageId": { - "type": "string", - "description": "Id to track resource usage for the provider." + "acceptedContentEncodings": { + "type": "array", + "description": "List of content encodings accepted by this target.", + "items": { + "type": "string" + } } } }, - "operation": { - "description": "Operation provided by provider", - "properties": { - "name": { - "type": "string", - "description": "Name of the operation" - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, - "display": { - "type": "object", - "description": "Properties of the operation", - "properties": { - "provider": { - "type": "string", - "description": "Provider name" - }, - "resource": { - "type": "string", - "description": "Resource name" - }, - "operation": { - "type": "string", - "description": "Operation name" - }, - "description": { - "type": "string", - "description": "Description of the operation" - } + "UsableStatus": { + "type": "string", + "description": "Whether the current workspace is ready to accept Jobs.", + "enum": [ + "Yes", + "No", + "Partial" + ], + "x-ms-enum": { + "name": "UsableStatus", + "modelAsString": true, + "values": [ + { + "name": "Yes", + "value": "Yes", + "description": "The workspace is usable and can accept jobs." + }, + { + "name": "No", + "value": "No", + "description": "The workspace is not usable and cannot accept jobs." + }, + { + "name": "Partial", + "value": "Partial", + "description": "The workspace is partially usable." } - } + ] } }, - "operationsList": { - "description": "Lists the operations available.", - "type": "object", - "properties": { - "nextLink": { - "description": "Url to follow for getting next page of operations.", - "type": "string" - }, - "value": { - "description": "Array of operations", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/operation" + "WorkspaceProvisioningStatus": { + "type": "string", + "description": "The Workspace provisioning status.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "ProviderLaunching", + "ProviderUpdating", + "ProviderDeleting", + "ProviderProvisioning" + ], + "x-ms-enum": { + "name": "WorkspaceProvisioningStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The Workspace provisioning is succeeded." }, - "x-ms-identifiers": [] - } + { + "name": "Failed", + "value": "Failed", + "description": "The Workspace provisioning failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "ProviderLaunching", + "value": "ProviderLaunching", + "description": "The Workspace is currently starting to provision a provider." + }, + { + "name": "ProviderUpdating", + "value": "ProviderUpdating", + "description": "The Workspace is currently updating a provider." + }, + { + "name": "ProviderDeleting", + "value": "ProviderDeleting", + "description": "The Workspace is currently deleting a provider." + }, + { + "name": "ProviderProvisioning", + "value": "ProviderProvisioning", + "description": "The Workspace is currently provisioning a provider." + } + ] }, - "required": [ - "value" - ] + "readOnly": true }, - "CheckNameAvailabilityParameters": { - "description": "Details of check name availability request body.", + "WorkspaceResourceProperties": { "type": "object", + "description": "Properties of a Workspace", "properties": { - "name": { - "type": "string", - "description": "Name for checking availability." + "providers": { + "type": "array", + "description": "List of Providers selected for this Workspace", + "items": { + "$ref": "#/definitions/Provider" + }, + "x-ms-identifiers": [ + "providerId" + ] }, - "type": { - "type": "string", - "default": "Microsoft.Quantum/Workspaces", - "description": "The resource type of Quantum Workspace." - } - } - }, - "CheckNameAvailabilityResult": { - "description": "Result of check name availability.", - "type": "object", - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Indicator of availability of the Quantum Workspace resource name." + "usable": { + "$ref": "#/definitions/UsableStatus", + "description": "Whether the current workspace is ready to accept Jobs.", + "readOnly": true }, - "reason": { + "provisioningState": { + "$ref": "#/definitions/WorkspaceProvisioningStatus", + "description": "Provisioning status field", + "readOnly": true + }, + "storageAccount": { "type": "string", - "description": "The reason of unavailability." + "description": "ARM Resource Id of the storage account associated with this workspace." }, - "message": { - "readOnly": true, + "endpointUri": { "type": "string", - "description": "The detailed info regarding the reason associated with the Namespace." + "description": "The URI of the workspace endpoint.", + "readOnly": true + }, + "apiKeyEnabled": { + "type": "boolean", + "description": "Indicator of enablement of the Quantum workspace Api keys." } } } }, - "parameters": { - "LocationParameter": { - "name": "locationName", - "in": "path", - "required": true, - "type": "string", - "description": "Location.", - "x-ms-parameter-location": "method" - }, - "WorkspaceNameParameter": { - "name": "workspaceName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", - "description": "The name of the quantum workspace resource.", - "x-ms-parameter-location": "method" - } - } + "parameters": {} } From c2e9dc9e2c7afeec6409cfc6f62aa9cb97f80501 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Thu, 30 Jan 2025 10:43:28 -0800 Subject: [PATCH 74/74] [EngSys] Add tests for GitHub Actions (#32409) - 100% code coverage --- .../update-labels/src/update-labels.js | 20 ++ .../update-labels/test/update-labels.test.js | 316 +++++++++++++++++- .github/src/context.js | 37 +- .github/test/context.test.js | 179 +++++++++- .github/test/mocks.js | 9 + 5 files changed, 537 insertions(+), 24 deletions(-) create mode 100644 .github/test/mocks.js diff --git a/.github/actions/update-labels/src/update-labels.js b/.github/actions/update-labels/src/update-labels.js index 4e9f36364e54..306725e0d814 100644 --- a/.github/actions/update-labels/src/update-labels.js +++ b/.github/actions/update-labels/src/update-labels.js @@ -19,6 +19,26 @@ export default async function updateLabels({ github, context, core }) { run_id = run_id || inputs.run_id; } + await updateLabelsImpl({ owner, repo, issue_number, run_id, github, core }); +} + +/** + * @param {Object} params + * @param {string} params.owner + * @param {string} params.repo + * @param {number} params.issue_number + * @param {number} params.run_id + * @param {(import("@octokit/core").Octokit & import("@octokit/plugin-rest-endpoint-methods/dist-types/types.js").Api & { paginate: import("@octokit/plugin-paginate-rest").PaginateInterface; })} params.github + * @param {typeof import("@actions/core")} params.core + */ +export async function updateLabelsImpl({ + owner, + repo, + issue_number, + run_id, + github, + core, +}) { /** @type {string[]} */ let artifactNames = []; diff --git a/.github/actions/update-labels/test/update-labels.test.js b/.github/actions/update-labels/test/update-labels.test.js index bc6e8bf32165..ad1a8a6a1331 100644 --- a/.github/actions/update-labels/test/update-labels.test.js +++ b/.github/actions/update-labels/test/update-labels.test.js @@ -1,11 +1,315 @@ -import { describe, expect, it } from "vitest"; -import updateLabels from "../src/update-labels.js"; +import { describe, expect, it, vi } from "vitest"; +import { createMockCore } from "../../../test/mocks.js"; +import updateLabels, { updateLabelsImpl } from "../src/update-labels.js"; + +describe("updateLabels", () => { + it("loads inputs from env", async () => { + const github = createMockGithub(); + github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({ + data: { + artifacts: [{ name: "label-foo=true" }], + }, + }); + + try { + process.env.OWNER = "TestRepoOwnerLoginEnv"; + process.env.REPO = "TestRepoNameEnv"; + process.env.ISSUE_NUMBER = "123"; + process.env.RUN_ID = "456"; + + await expect( + updateLabels({ + github: github, + context: null, + core: createMockCore(), + }), + ).resolves.toBeUndefined(); + } finally { + delete process.env.OWNER; + delete process.env.REPO; + delete process.env.ISSUE_NUMBER; + delete process.env.RUN_ID; + } + + expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({ + owner: "TestRepoOwnerLoginEnv", + repo: "TestRepoNameEnv", + run_id: 456, + }); + expect(github.rest.issues.addLabels).toBeCalledWith({ + owner: "TestRepoOwnerLoginEnv", + repo: "TestRepoNameEnv", + issue_number: 123, + labels: ["foo"], + }); + expect(github.rest.issues.removeLabel).toBeCalledTimes(0); + }); + + it("loads inputs from context", async () => { + const github = createMockGithub(); + github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({ + data: { + artifacts: [{ name: "label-foo=true" }], + }, + }); + + const context = { + eventName: "workflow_run", + payload: { + action: "completed", + workflow_run: { + head_sha: "abc123", + id: 456, + repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLogin", + }, + }, + pull_requests: [{ number: 123 }], + }, + }, + }; + + await expect( + updateLabels({ + github: github, + context: context, + core: createMockCore(), + }), + ).resolves.toBeUndefined(); + + expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({ + owner: "TestRepoOwnerLogin", + repo: "TestRepoName", + run_id: 456, + }); + expect(github.rest.issues.addLabels).toBeCalledWith({ + owner: "TestRepoOwnerLogin", + repo: "TestRepoName", + issue_number: 123, + labels: ["foo"], + }); + expect(github.rest.issues.removeLabel).toBeCalledTimes(0); + }); + + it("loads inputs from env and context", async () => { + const github = createMockGithub(); + github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({ + data: { + artifacts: [{ name: "label-foo=true" }], + }, + }); + + const context = { + eventName: "workflow_run", + payload: { + action: "completed", + workflow_run: { + head_sha: "abc123", + id: 456, + repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLogin", + }, + }, + pull_requests: [{ number: 123 }], + }, + }, + }; + + try { + process.env.OWNER = "TestRepoOwnerLoginEnv"; + process.env.REPO = "TestRepoNameEnv"; + + await expect( + updateLabels({ + github: github, + context: context, + core: createMockCore(), + }), + ).resolves.toBeUndefined(); + } finally { + delete process.env.OWNER; + delete process.env.REPO; + } + + expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({ + owner: "TestRepoOwnerLoginEnv", + repo: "TestRepoNameEnv", + run_id: 456, + }); + expect(github.rest.issues.addLabels).toBeCalledWith({ + owner: "TestRepoOwnerLoginEnv", + repo: "TestRepoNameEnv", + issue_number: 123, + labels: ["foo"], + }); + expect(github.rest.issues.removeLabel).toBeCalledTimes(0); + }); +}); + +describe("updateLabelsImpl", () => { + it("throws if no run_id", async () => { + const github = createMockGithub(); -describe("update-labels", () => { - // TODO: Replace with better tests - it("throws if inputs null", async () => { await expect( - updateLabels({ github: null, context: null, core: null }), + updateLabelsImpl({ + owner: "owner", + repo: "repo", + issue_number: 123, + run_id: NaN, + github: github, + core: createMockCore(), + }), ).rejects.toThrow(); + + expect(github.rest.issues.addLabels).toBeCalledTimes(0); + expect(github.rest.issues.removeLabel).toBeCalledTimes(0); + }); + + it("adds and removes labels for artifacts", async () => { + const github = createMockGithub(); + github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({ + data: { + artifacts: [ + { name: "label-foo=true" }, + { name: "label-bar=true" }, + { name: "label-baz=false" }, + { name: "label-qux=false" }, + { name: "ignoredNoEquals" }, + { name: "=ignoredNoKey" }, + { name: "label=ignoredKeyNotStartsWithLabelDash" }, + ], + }, + }); + + await expect( + updateLabelsImpl({ + owner: "owner", + repo: "repo", + issue_number: 123, + run_id: 456, + github: github, + core: createMockCore(), + }), + ).resolves.toBeUndefined(); + + expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({ + owner: "owner", + repo: "repo", + run_id: 456, + }); + expect(github.rest.issues.addLabels).toBeCalledWith({ + owner: "owner", + repo: "repo", + issue_number: 123, + labels: ["foo", "bar"], + }); + expect(github.rest.issues.removeLabel).toBeCalledTimes(2); + expect(github.rest.issues.removeLabel).nthCalledWith(1, { + owner: "owner", + repo: "repo", + issue_number: 123, + name: "baz", + }); + expect(github.rest.issues.removeLabel).nthCalledWith(2, { + owner: "owner", + repo: "repo", + issue_number: 123, + name: "qux", + }); + }); + + it("throws for invalid label value", async () => { + const github = createMockGithub(); + github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({ + data: { + artifacts: [ + { name: "label-foo=true" }, + { name: "label-bar=false" }, + { name: "label-baz=invalid" }, + ], + }, + }); + + await expect( + updateLabelsImpl({ + owner: "owner", + repo: "repo", + issue_number: 123, + run_id: 456, + github: github, + core: createMockCore(), + }), + ).rejects.toThrow(); + + expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({ + owner: "owner", + repo: "repo", + run_id: 456, + }); + + // Ensure no labels are added or removed if any are invalid + expect(github.rest.issues.addLabels).toBeCalledTimes(0); + expect(github.rest.issues.removeLabel).toBeCalledTimes(0); }); + + it.each([404, 500, 501])( + "handles error removing label (%s)", + async (status) => { + const github = createMockGithub(); + github.rest.actions.listWorkflowRunArtifacts.mockResolvedValue({ + data: { + artifacts: [{ name: "label-foo=false" }], + }, + }); + github.rest.issues.removeLabel.mockRejectedValue({ status: status }); + + const updateLabelsImplPromise = updateLabelsImpl({ + owner: "owner", + repo: "repo", + issue_number: 123, + run_id: 456, + github: github, + core: createMockCore(), + }); + + if (status == 404) { + await expect(updateLabelsImplPromise).resolves.toBeUndefined(); + } else { + await expect(updateLabelsImplPromise).rejects.toThrow(); + } + + expect(github.rest.actions.listWorkflowRunArtifacts).toBeCalledWith({ + owner: "owner", + repo: "repo", + run_id: 456, + }); + expect(github.rest.issues.addLabels).toBeCalledTimes(0); + expect(github.rest.issues.removeLabel).toBeCalledWith({ + owner: "owner", + repo: "repo", + issue_number: 123, + name: "foo", + }); + }, + ); }); + +function createMockGithub() { + return { + rest: { + actions: { + listWorkflowRunArtifacts: vi + .fn() + .mockResolvedValue({ data: { artifacts: [] } }), + }, + issues: { + addLabels: vi.fn(), + removeLabel: vi.fn(), + }, + }, + }; +} diff --git a/.github/src/context.js b/.github/src/context.js index 2e5dd048409a..6dfd693b8766 100644 --- a/.github/src/context.js +++ b/.github/src/context.js @@ -12,6 +12,9 @@ export async function extractInputs(github, context, core) { core.info(`extractInputs(${context.eventName}, ${context.payload.action})`); + /** @type {{ owner: string, repo: string, head_sha: string, issue_number: number, run_id: number }} */ + let inputs; + // Add support for more event types as needed if (context.eventName === "pull_request") { const payload = @@ -19,17 +22,26 @@ export async function extractInputs(github, context, core) { context.payload ); - const inputs = { + inputs = { owner: payload.repository.owner.login, repo: payload.repository.name, head_sha: payload.pull_request.head.sha, - issue_number: payload.number, + issue_number: payload.pull_request.number, run_id: NaN, }; + } else if (context.eventName === "workflow_dispatch") { + const payload = + /** @type {import("@octokit/webhooks-types").WorkflowDispatchEvent} */ ( + context.payload + ); - core.info(`inputs: ${JSON.stringify(inputs)}`); - - return inputs; + inputs = { + owner: payload.repository.owner.login, + repo: payload.repository.name, + head_sha: "", + issue_number: NaN, + run_id: NaN, + }; } else if ( context.eventName === "workflow_run" && context.payload.action === "completed" @@ -50,7 +62,7 @@ export async function extractInputs(github, context, core) { } else { // For fork PRs, we must call an API in the head repository to get the PR number in the target repository - // Owner and repo for the PR head (may differ from target for fork PRs) + // Owner and repo for the PR head (at least one should differ from target for fork PRs) const head_owner = payload.workflow_run.head_repository.owner.login; const head_repo = payload.workflow_run.head_repository.name; const head_sha = payload.workflow_run.head_sha; @@ -69,25 +81,24 @@ export async function extractInputs(github, context, core) { issue_number = pullRequests[0].number; } else { throw new Error( - `Unexpected number of pull requests associated with commit '${head_sha}'. Expected: '1'. Actual '${pullRequests.length}'.`, + `Unexpected number of pull requests associated with commit '${head_sha}'. Expected: '1'. Actual: '${pullRequests.length}'.`, ); } } - const inputs = { + inputs = { owner: payload.workflow_run.repository.owner.login, repo: payload.workflow_run.repository.name, head_sha: payload.workflow_run.head_sha, issue_number: issue_number, run_id: payload.workflow_run.id, }; - - core.info(`inputs: ${JSON.stringify(inputs)}`); - - return inputs; } else { throw new Error( - `Invalid context: '${context.eventName}:${context.payload.action}'. Expected 'workflow_run:completed'.`, + `Context '${context.eventName}:${context.payload.action}' is not yet supported.`, ); } + + core.info(`inputs: ${JSON.stringify(inputs)}`); + return inputs; } diff --git a/.github/test/context.test.js b/.github/test/context.test.js index 593ab2a18a0e..328da2a35ec3 100644 --- a/.github/test/context.test.js +++ b/.github/test/context.test.js @@ -1,9 +1,178 @@ -import { describe, expect, it } from "vitest"; +import { describe, expect, it, vi } from "vitest"; import { extractInputs } from "../src/context.js"; +import { createMockCore } from "./mocks.js"; -describe("context", () => { - // TODO: Replace with better tests - it("throws if inputs null", async () => { - await expect(extractInputs(null, null, null)).rejects.toThrow(); +describe("extractInputs", () => { + it("unsupported_event", async () => { + const context = { + eventName: "unsupported_event", + payload: { + action: "unsupported_action", + }, + }; + + await expect( + extractInputs(null, context, createMockCore()), + ).rejects.toThrow(); }); + + it("pull_request", async () => { + const context = { + eventName: "pull_request", + payload: { + repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLogin", + }, + }, + pull_request: { + head: { + sha: "abc123", + }, + number: 123, + }, + }, + }; + + await expect( + extractInputs(null, context, createMockCore()), + ).resolves.toEqual({ + owner: "TestRepoOwnerLogin", + repo: "TestRepoName", + head_sha: "abc123", + issue_number: 123, + run_id: NaN, + }); + }); + + it("workflow_dispatch", async () => { + const context = { + eventName: "workflow_dispatch", + payload: { + repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLogin", + }, + }, + }, + }; + + await expect( + extractInputs(null, context, createMockCore()), + ).resolves.toEqual({ + owner: "TestRepoOwnerLogin", + repo: "TestRepoName", + head_sha: "", + issue_number: NaN, + run_id: NaN, + }); + }); + + it("workflow_run:unsupported_action", async () => { + const context = { + eventName: "workflow_run", + payload: { + action: "unsupported_action", + }, + }; + + await expect( + extractInputs(null, context, createMockCore()), + ).rejects.toThrow(); + }); + + it("workflow_run:completed (same repo)", async () => { + const context = { + eventName: "workflow_run", + payload: { + action: "completed", + workflow_run: { + head_sha: "abc123", + id: 456, + repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLogin", + }, + }, + pull_requests: [{ number: 123 }], + }, + }, + }; + + await expect( + extractInputs(null, context, createMockCore()), + ).resolves.toEqual({ + owner: "TestRepoOwnerLogin", + repo: "TestRepoName", + head_sha: "abc123", + issue_number: 123, + run_id: 456, + }); + }); + + it.each([0, 1, 2])( + "workflow_run:completed (fork repo, %s PRs)", + async (numPullRequests) => { + const context = { + eventName: "workflow_run", + payload: { + action: "completed", + workflow_run: { + head_repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLoginFork", + }, + }, + head_sha: "abc123", + id: 456, + repository: { + name: "TestRepoName", + owner: { + login: "TestRepoOwnerLogin", + }, + }, + pull_requests: [], + }, + }, + }; + + const github = { + rest: { + repos: { + listPullRequestsAssociatedWithCommit: vi.fn().mockResolvedValue({ + data: [{ number: 123 }, { number: 124 }].slice( + 0, + numPullRequests, + ), + }), + }, + }, + }; + + const inputsPromise = extractInputs(github, context, createMockCore()); + if (numPullRequests === 1) { + await expect(inputsPromise).resolves.toEqual({ + owner: "TestRepoOwnerLogin", + repo: "TestRepoName", + head_sha: "abc123", + issue_number: 123, + run_id: 456, + }); + } else { + await expect(inputsPromise).rejects.toThrow(); + } + + expect( + github.rest.repos.listPullRequestsAssociatedWithCommit, + ).toHaveBeenCalledWith({ + owner: "TestRepoOwnerLoginFork", + repo: "TestRepoName", + commit_sha: "abc123", + }); + }, + ); }); diff --git a/.github/test/mocks.js b/.github/test/mocks.js new file mode 100644 index 000000000000..11e87a937aec --- /dev/null +++ b/.github/test/mocks.js @@ -0,0 +1,9 @@ +import { vi } from "vitest"; + +// Partial mock of `core` parameter passed into to github-script actions +export function createMockCore() { + return { + debug: vi.fn(console.debug), + info: vi.fn(console.log), + }; +}